Run and Run Step API

Runs are processes that execute the assistant’s logic within a thread, allowing it to process messages, generate responses, and call external tools if needed. Runs go through different statuses, such as queued, in_progress, and completed, and trigger events based on their progress, including tool calls and message updates.

This page provides API schemas for the following methods:

Create a Run	https://api.aimlapi.com/threads/{threadId}/runs
Create a Thread and run it in one request	https://api.aimlapi.com/threads/runs
Retrieve a list of Runs belonging to a specific Thread	https://api.aimlapi.com/threads/{threadId}/runs
Retrieve information about a specific Run by its ID	https://api.aimlapi.com/threads/{threadId}/runs/{runId}
Modify a specific Run by its ID	https://api.aimlapi.com/threads/{threadId}/runs/{runId}
Submit Tool outputs to a specific Run	https://api.aimlapi.com/threads/{threadId}/runs/{runId}/submit_tool_outputs
Cancel a specific Run by its ID	https://api.aimlapi.com/threads/{threadId}/runs/{runId}/cancel
Retrieve a list of Run Steps belonging to a specific Run	https://api.aimlapi.com/threads/{threadId}/runs/{runId}/steps
Retrieve information about a specific Run Step by its ID	https://api.aimlapi.com/threads/{threadId}/runs/{runId}/steps/{stepId}

After each schema, you'll find a short example demonstrating how to correctly call the described method in code using the OpenAI SDK.

Note that the method names in the API schema and the SDK often differ. Accordingly, when calling these methods via the REST API, you should use the names from the API schema, while for calls through the OpenAI SDK, use the names from the examples.

API Schemas

Create a run

post

Authorizations

Path parameters

threadIdstringrequired

Body

assistant_idstringrequired

The ID of the assistant to use to execute this run

additional_instructionsstring | nullableoptional

Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

additional_messagesobject[] | nullableoptional

Adds additional messages to the thread before creating the run.

instructionsstring | nullableoptional

Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

max_completion_tokensinteger | nullableoptional

The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status incomplete

max_prompt_tokensinteger | nullableoptional

The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status incomplete

metadataany | nullableoptional

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

modelstring · enumoptional

The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

Options: gpt-4o, gpt-4o-2024-08-06, gpt-4o-2024-05-13, gpt-4o-mini, gpt-4o-mini-2024-07-18, chatgpt-4o-latest, gpt-4-turbo, gpt-4-turbo-2024-04-09, gpt-4, gpt-4-0125-preview, gpt-4-1106-preview, gpt-3.5-turbo, gpt-3.5-turbo-0125, gpt-3.5-turbo-1106, o1-preview, o1-preview-2024-09-12, o1-mini, o1-mini-2024-09-12, o3-mini, gpt-4.5-preview

parallel_tool_callsbooleanoptional

Whether to enable parallel function calling during tool use.

reasoning_effortstring · enumoptional

Constrains effort on reasoning for reasoning models

Options: low, medium, high

response_formatany ofoptional

Specifies the format that the model must output

streamboolean | nullableoptional

If true, returns a stream of events that happen during the Run as server-sent events

temperaturenumber · max: 2optional

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

tool_choiceany ofoptional

Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user

toolsone of[] | nullableoptional

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

top_pnumber | nullableoptional

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

truncation_strategyobject | nullableoptional

Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "assistant_id": "text",
    "additional_instructions": "text",
    "additional_messages": [
      {
        "role": "user",
        "content": "text",
        "attachments": [
          {
            "file_id": "text",
            "tools": [
              {
                "type": "code_interpreter"
              }
            ]
          }
        ],
        "metadata": null
      }
    ],
    "instructions": "text",
    "max_completion_tokens": 1,
    "max_prompt_tokens": 1,
    "metadata": null,
    "model": "gpt-4o",
    "parallel_tool_calls": true,
    "reasoning_effort": "low",
    "response_format": "auto",
    "stream": true,
    "temperature": 1,
    "tool_choice": "none",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "top_p": 1,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": 1
    }
  }'

default

default

{
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "id": "text",
  "incomplete_details": {
    "reason": "text"
  },
  "instructions": "text",
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "max_completion_tokens": 1,
  "max_prompt_tokens": 1,
  "metadata": null,
  "model": "text",
  "object": "thread.run",
  "parallel_tool_calls": true,
  "required_action": {
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "function": {
            "arguments": "text",
            "name": "text"
          },
          "id": "text",
          "type": "function"
        }
      ]
    },
    "type": "submit_tool_outputs"
  },
  "response_format": "auto",
  "started_at": 1,
  "status": "queued",
  "temperature": 1,
  "thread_id": "text",
  "tool_choice": "none",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "top_p": 1,
  "truncation_strategy": {
    "type": "text",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.runs.create(
  thread_id="thread_abc123",
  assistant_id="asst_abc123"
)

print(run)

---

Create a Thread and run it in one request

post

Authorizations

Body

assistant_idstringrequired

The ID of the assistant to use to execute this run

instructionsstring | nullableoptional

Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

max_completion_tokensinteger | nullableoptional

The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status incomplete

max_prompt_tokensinteger | nullableoptional

The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status incomplete

metadataany | nullableoptional

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

modelstring · enum | nullableoptional

The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

Options: gpt-4o, gpt-4o-2024-08-06, gpt-4o-2024-05-13, gpt-4o-mini, gpt-4o-mini-2024-07-18, chatgpt-4o-latest, gpt-4-turbo, gpt-4-turbo-2024-04-09, gpt-4, gpt-4-0125-preview, gpt-4-1106-preview, gpt-3.5-turbo, gpt-3.5-turbo-0125, gpt-3.5-turbo-1106, o1-preview, o1-preview-2024-09-12, o1-mini, o1-mini-2024-09-12, o3-mini, gpt-4.5-preview

parallel_tool_callsbooleanoptional

Whether to enable parallel function calling during tool use.

response_formatany ofoptional

Specifies the format that the model must output

streamboolean | nullableoptional

If true, returns a stream of events that happen during the Run as server-sent events

temperaturenumber | nullableoptional

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

threadobjectoptional

Options to create a new thread. If no thread is provided when running a request, an empty thread will be created

tool_choiceany ofoptional

Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user

tool_resourcesobject | nullableoptional

A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

toolsone of[] | nullableoptional

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

top_pnumber | nullableoptional

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

truncation_strategyobject | nullableoptional

Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/threads/runs' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "assistant_id": "text",
    "instructions": "text",
    "max_completion_tokens": 1,
    "max_prompt_tokens": 1,
    "metadata": null,
    "model": "gpt-4o",
    "parallel_tool_calls": true,
    "response_format": "auto",
    "stream": true,
    "temperature": 1,
    "thread": {
      "messages": [
        {
          "role": "user",
          "content": "text",
          "attachments": [
            {
              "file_id": "text",
              "tools": [
                {
                  "type": "code_interpreter"
                }
              ]
            }
          ],
          "metadata": null
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "tool_resources": {
        "code_interpreter": {
          "file_ids": []
        },
        "file_search": {
          "vector_store_ids": [
            "text"
          ],
          "vector_stores": [
            {
              "chunking_strategy": {
                "type": "auto"
              },
              "file_ids": [
                "text"
              ],
              "metadata": {
                "ANY_ADDITIONAL_PROPERTY": null
              }
            }
          ]
        }
      }
    },
    "tool_choice": "none",
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      },
      "file_search": {
        "vector_store_ids": [
          "text"
        ],
        "vector_stores": [
          {
            "chunking_strategy": {
              "type": "auto"
            },
            "file_ids": [
              "text"
            ],
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": null
            }
          }
        ]
      }
    },
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "top_p": 1,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": 1
    }
  }'

default

default

{
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "id": "text",
  "incomplete_details": {
    "reason": "text"
  },
  "instructions": "text",
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "max_completion_tokens": 1,
  "max_prompt_tokens": 1,
  "metadata": null,
  "model": "text",
  "object": "thread.run",
  "parallel_tool_calls": true,
  "required_action": {
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "function": {
            "arguments": "text",
            "name": "text"
          },
          "id": "text",
          "type": "function"
        }
      ]
    },
    "type": "submit_tool_outputs"
  },
  "response_format": "auto",
  "started_at": 1,
  "status": "queued",
  "temperature": 1,
  "thread_id": "text",
  "tool_choice": "none",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "top_p": 1,
  "truncation_strategy": {
    "type": "text",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.create_and_run(
  assistant_id="asst_abc123",
  thread={
    "messages": [
      {"role": "user", "content": "Explain deep learning to a 5 year old."}
    ]
  }
)

print(run)

---

Retrieve a list of Runs belonging to a specific Thread

get

Authorizations

Path parameters

threadIdstringrequired

Query parameters

limitintegeroptional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

orderstringoptional

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

beforestringoptional

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

afterstringoptional

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

default

default

{
  "object": "list",
  "data": [
    {
      "assistant_id": "text",
      "cancelled_at": 1,
      "completed_at": 1,
      "created_at": 1,
      "expires_at": 1,
      "failed_at": 1,
      "id": "text",
      "incomplete_details": {
        "reason": "text"
      },
      "instructions": "text",
      "last_error": {
        "code": "server_error",
        "message": "text"
      },
      "max_completion_tokens": 1,
      "max_prompt_tokens": 1,
      "metadata": null,
      "model": "text",
      "object": "thread.run",
      "parallel_tool_calls": true,
      "required_action": {
        "submit_tool_outputs": {
          "tool_calls": [
            {
              "function": {
                "arguments": "text",
                "name": "text"
              },
              "id": "text",
              "type": "function"
            }
          ]
        },
        "type": "submit_tool_outputs"
      },
      "response_format": "auto",
      "started_at": 1,
      "status": "queued",
      "temperature": 1,
      "thread_id": "text",
      "tool_choice": "none",
      "tools": [
        {
          "type": "code_interpreter"
        }
      ],
      "top_p": 1,
      "truncation_strategy": {
        "type": "text",
        "last_messages": 1
      },
      "usage": {
        "completion_tokens": 1,
        "prompt_tokens": 1,
        "total_tokens": 1
      }
    }
  ],
  "first_id": "text",
  "last_id": "text",
  "has_more": true
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

runs = client.beta.threads.runs.list(
  "thread_abc123"
)

print(runs)

---

Retrieve information about a specific Run by its ID

get

Authorizations

Path parameters

threadIdstringrequired

runIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs/{runId}' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

default

default

{
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "id": "text",
  "incomplete_details": {
    "reason": "text"
  },
  "instructions": "text",
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "max_completion_tokens": 1,
  "max_prompt_tokens": 1,
  "metadata": null,
  "model": "text",
  "object": "thread.run",
  "parallel_tool_calls": true,
  "required_action": {
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "function": {
            "arguments": "text",
            "name": "text"
          },
          "id": "text",
          "type": "function"
        }
      ]
    },
    "type": "submit_tool_outputs"
  },
  "response_format": "auto",
  "started_at": 1,
  "status": "queued",
  "temperature": 1,
  "thread_id": "text",
  "tool_choice": "none",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "top_p": 1,
  "truncation_strategy": {
    "type": "text",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.runs.retrieve(
  thread_id="thread_abc123",
  run_id="run_abc123"
)

print(run)

---

Modify a specific run by its ID

post

Authorizations

Path parameters

threadIdstringrequired

runIdstringrequired

Body

metadataobjectrequired

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs/{runId}' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": null
    }
  }'

default

default

{
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "id": "text",
  "incomplete_details": {
    "reason": "text"
  },
  "instructions": "text",
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "max_completion_tokens": 1,
  "max_prompt_tokens": 1,
  "metadata": null,
  "model": "text",
  "object": "thread.run",
  "parallel_tool_calls": true,
  "required_action": {
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "function": {
            "arguments": "text",
            "name": "text"
          },
          "id": "text",
          "type": "function"
        }
      ]
    },
    "type": "submit_tool_outputs"
  },
  "response_format": "auto",
  "started_at": 1,
  "status": "queued",
  "temperature": 1,
  "thread_id": "text",
  "tool_choice": "none",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "top_p": 1,
  "truncation_strategy": {
    "type": "text",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.runs.update(
  thread_id="thread_abc123",
  run_id="run_abc123",
  metadata={"user_id": "user_abc123"},
)

print(run)

---

Submit Tool outputs to a specific Run

post

Authorizations

Path parameters

threadIdstringrequired

runIdstringrequired

Body

tool_outputsobject[]required

A list of tools for which the outputs are being submitted.

streamboolean | nullableoptional

If true, returns a stream of events that happen during the Run as server-sent events

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs/{runId}/submit_tool_outputs' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "tool_outputs": [
      {
        "output": "text",
        "tool_call_id": "text"
      }
    ],
    "stream": true
  }'

default

default

{
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "id": "text",
  "incomplete_details": {
    "reason": "text"
  },
  "instructions": "text",
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "max_completion_tokens": 1,
  "max_prompt_tokens": 1,
  "metadata": null,
  "model": "text",
  "object": "thread.run",
  "parallel_tool_calls": true,
  "required_action": {
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "function": {
            "arguments": "text",
            "name": "text"
          },
          "id": "text",
          "type": "function"
        }
      ]
    },
    "type": "submit_tool_outputs"
  },
  "response_format": "auto",
  "started_at": 1,
  "status": "queued",
  "temperature": 1,
  "thread_id": "text",
  "tool_choice": "none",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "top_p": 1,
  "truncation_strategy": {
    "type": "text",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.runs.submit_tool_outputs(
  thread_id="thread_123",
  run_id="run_123",
  tool_outputs=[
    {
      "tool_call_id": "call_001",
      "output": "70 degrees and sunny."
    }
  ]
)

print(run)

---

Cancel a specific Run by its ID

post

Authorizations

Path parameters

threadIdstringrequired

runIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs/{runId}/cancel' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

default

default

{
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "id": "text",
  "incomplete_details": {
    "reason": "text"
  },
  "instructions": "text",
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "max_completion_tokens": 1,
  "max_prompt_tokens": 1,
  "metadata": null,
  "model": "text",
  "object": "thread.run",
  "parallel_tool_calls": true,
  "required_action": {
    "submit_tool_outputs": {
      "tool_calls": [
        {
          "function": {
            "arguments": "text",
            "name": "text"
          },
          "id": "text",
          "type": "function"
        }
      ]
    },
    "type": "submit_tool_outputs"
  },
  "response_format": "auto",
  "started_at": 1,
  "status": "queued",
  "temperature": 1,
  "thread_id": "text",
  "tool_choice": "none",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "top_p": 1,
  "truncation_strategy": {
    "type": "text",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.runs.cancel(
  thread_id="thread_abc123",
  run_id="run_abc123"
)

print(run)

---

Retrieve a list of Run Steps belonging to a specific Run

get

Authorizations

Path parameters

threadIdstringrequired

runIdstringrequired

Query parameters

limitintegeroptional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

orderstringoptional

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

beforestringoptional

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

afterstringoptional

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

run_idstringoptional

Filter messages by the run ID that generated them

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs/{runId}/steps' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

default

default

{
  "object": "list",
  "data": [
    {
      "assistant_id": "text",
      "cancelled_at": 1,
      "completed_at": 1,
      "created_at": 1,
      "expired_at": 1,
      "failed_at": 1,
      "id": "text",
      "last_error": {
        "code": "server_error",
        "message": "text"
      },
      "metadata": null,
      "object": "thread.run.step",
      "run_id": "text",
      "status": "in_progress",
      "step_details": {
        "message_creation": {
          "message_id": "text"
        },
        "type": "message_creation"
      },
      "thread_id": "text",
      "type": "message_creation",
      "usage": {
        "completion_tokens": 1,
        "prompt_tokens": 1,
        "total_tokens": 1
      }
    }
  ],
  "first_id": "text",
  "last_id": "text",
  "has_more": true
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run_steps = client.beta.threads.runs.steps.list(
    thread_id="thread_abc123",
    run_id="run_abc123"
)

print(run_steps)

---

Retrieve information about a specific Run Step by its ID

get

Authorizations

Path parameters

threadIdstringrequired

runIdstringrequired

stepIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.aimlapi.com/threads/{threadId}/runs/{runId}/steps/{stepId}' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

default

default

{
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expired_at": 1,
  "failed_at": 1,
  "id": "text",
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "metadata": null,
  "object": "thread.run.step",
  "run_id": "text",
  "status": "in_progress",
  "step_details": {
    "message_creation": {
      "message_id": "text"
    },
    "type": "message_creation"
  },
  "thread_id": "text",
  "type": "message_creation",
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

run_step = client.beta.threads.runs.steps.retrieve(
    thread_id="thread_abc123",
    run_id="run_abc123",
    step_id="step_abc123"
)

print(run_step)