Get Runs By Thread

GET

api

threads

{threadId}

runs

Get runs by thread

curl --request GET \
  --url https://itz.am/api/v1/threads/{threadId}/runs \
  --header 'Api-Key: <api-key>'

{
  "runs": [
    {
      "id": "run_1234567890",
      "origin": "API",
      "status": "COMPLETED",
      "input": "Who are you?",
      "output": "I'm a helpful assistant",
      "prompt": "Be friendly and helpful",
      "inputTokens": 100,
      "outputTokens": 100,
      "cost": "0.001",
      "durationInMs": 100,
      "threadId": "thread_1234567890",
      "model": {
        "name": "GPT-4o",
        "tag": "openai:gpt-4o"
      },
      "attachments": [
        {
          "url": "https://example.com/image.jpg",
          "mimeType": "image/jpeg",
          "id": "attachment_1234567890"
        }
      ],
      "knowledge": [
        {
          "id": "1353151353531",
          "title": "My Resource",
          "url": "https://example.com/resource.pdf",
          "type": "file"
        }
      ],
      "workflowId": "workflow_1234567890",
      "createdAt": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Authorizations

Api-Key

string

header

required

The API key to use for authentication

Path Parameters

threadId

string

required

The ID of the thread to get runs for

Example:

"thread_1234567890"

Response

Successfully retrieved thread runs

runs

object[]

required

Array of runs in the thread

Show child attributes

runs.id

string

required

The ID of the run

Example:

"run_1234567890"

runs.origin

string

required

The origin of the run

Example:

"API"

runs.status

string

required

The status of the run

Example:

"COMPLETED"

runs.input

string

required

The input of the run

Example:

"Who are you?"

runs.output

string

required

The output of the run

Example:

"I'm a helpful assistant"

runs.prompt

string

required

The prompt of the run

Example:

"Be friendly and helpful"

runs.inputTokens

number

required

The number of input tokens of the run

Example:

100

runs.outputTokens

number

required

The number of output tokens of the run

Example:

100

runs.cost

string

required

The cost of the run

Example:

"0.001"

runs.durationInMs

number

required

The duration of the run in milliseconds

Example:

100

runs.threadId

string | null

required

The thread ID of the run

Example:

"thread_1234567890"

runs.model

object

required

Show child attributes

runs.model.name

string

required

The name of the model

Example:

"GPT-4o"

runs.model.tag

string

required

The tag of the model

Example:

"openai:gpt-4o"

runs.attachments

object[] | null

required

Show child attributes

runs.attachments.url

string

required

The URL of the attachment

Example:

"https://example.com/image.jpg"

runs.attachments.mimeType

string

required

The MIME type of the attachment

Example:

"image/jpeg"

runs.attachments.id

string

required

The ID of the attachment

Example:

"attachment_1234567890"

runs.knowledge

object[] | null

required

Show child attributes

runs.knowledge.id

string

required

The ID of the knowledge

Example:

"1353151353531"

runs.knowledge.title

string | null

required

The title of the knowledge

Example:

"My Resource"

runs.knowledge.url

string

required

The URL of the knowledge

Example:

"https://example.com/resource.pdf"

runs.knowledge.type

string

required

The type of the knowledge

Example:

"file"

runs.workflowId

string

required

The ID of the workflow

Example:

"workflow_1234567890"

runs.createdAt

string

required

The creation date of the run

Example:

"2021-01-01T00:00:00.000Z"

Get Run By IdRetrieve the run details by its ID

⌘I

Get runs by thread

curl --request GET \
  --url https://itz.am/api/v1/threads/{threadId}/runs \
  --header 'Api-Key: <api-key>'

{
  "runs": [
    {
      "id": "run_1234567890",
      "origin": "API",
      "status": "COMPLETED",
      "input": "Who are you?",
      "output": "I'm a helpful assistant",
      "prompt": "Be friendly and helpful",
      "inputTokens": 100,
      "outputTokens": 100,
      "cost": "0.001",
      "durationInMs": 100,
      "threadId": "thread_1234567890",
      "model": {
        "name": "GPT-4o",
        "tag": "openai:gpt-4o"
      },
      "attachments": [
        {
          "url": "https://example.com/image.jpg",
          "mimeType": "image/jpeg",
          "id": "attachment_1234567890"
        }
      ],
      "knowledge": [
        {
          "id": "1353151353531",
          "title": "My Resource",
          "url": "https://example.com/resource.pdf",
          "type": "file"
        }
      ],
      "workflowId": "workflow_1234567890",
      "createdAt": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Text

Object

Threads

Runs

Models

Errors

Get Runs By Thread

Authorizations

Path Parameters

Response