Introduction

In this section, the developers will learn how to execute verifiable Functions/API tasks and get the execution transcript.

Authorization

API KEY

We use API_KEY to grant access to task execution. To get authorized using an API Key, include the registered API Key in the call's header. This allows the dispatcher service to validate access and identify who will cover the cost of the task execution (the address associated with the API Key).

Example

X-API-KEY: be0dc6ba-9a60-4777-b5b7-60ed2397e3ed

Task execution API

Use the following endpoints to execute your Function Task and API Task to obtain a verified result. Ensure you have the namespace and taskname beforehand to call any of these endpoints.

• To run a Function Task, please call this endpoint and specify the Namespace, Task name , task inputs, and task metadata.

• To run an API Task, please call this endpoint and specify the Namespace, Task name , task inputs, and task metadata.

• Use these endpoints to poll for outputs of asynchronous or long-running tasks.

  • Function Task status endpoint

  • Api Task status endpoint

API Doc

Interactive API docs can be found at: https://run.truebit.network/dispatcher/api-docs/

Transcript API

Use the following endpoints to retrieve the transcript associated with an existing executionId or transcriptHash

• Get transcript by execution ID endpoint
• Get transcript by Transcript hash endpoint

You can also get information attached to the transcript such as the invoice.

• Get invoice by execution ID endpoint

API Doc

Interactive API docs can be found at: https://run.truebit.network/transcript-query/api-docs/

Transcript

The transcript is the source of truth of what happened during the Task execution. It contains every single step that happened in a transparent and verifiable way.

Please check the following links to learn how the Function and API transcript are built.

• What is a transcript?

• Function task Transcript example

• API Task Transcript example