Runs

API Reference

列出所有线程运行。

get

返回线程运行列表，代表线程内的单独执行或交互。

路径参数

threadIdstring必填

响应

201成功

application/json

get

/threads/{threadId}/runs

HTTPcURLJavaScriptPython

GET /threads/{threadId}/runs HTTP/1.1
Host: api.aimlapi.com
Accept: */*

201成功

[
  {
    "id": "text",
    "assistant_id": "text",
    "cancelled_at": 1,
    "completed_at": 1,
    "created_at": 1,
    "expires_at": 1,
    "failed_at": 1,
    "incomplete_details": {
      "reason": "max_completion_tokens"
    },
    "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": []
      },
      "type": "submit_tool_outputs"
    },
    "response_format": null,
    "started_at": 1,
    "status": "queued",
    "thread_id": "text",
    "tool_choice": null,
    "tools": [],
    "truncation_strategy": {
      "type": "auto",
      "last_messages": 1
    },
    "usage": {
      "completion_tokens": 1,
      "prompt_tokens": 1,
      "total_tokens": 1
    },
    "temperature": 1,
    "top_p": 1
  }
]

创建新的线程运行。

post

创建一个新的线程运行，在线程上下文中执行任务或交互。

路径参数

threadIdstring必填

请求体

application/json

assistant_idstring必填

streamboolean可选

metadataobject可选

响应

201成功

application/json

post

/threads/{threadId}/runs

HTTPcURLJavaScriptPython

POST /threads/{threadId}/runs HTTP/1.1
Host: api.aimlapi.com
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "assistant_id": "text",
  "stream": true,
  "metadata": {}
}

201成功

{
  "id": "text",
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "incomplete_details": {
    "reason": "max_completion_tokens"
  },
  "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": []
    },
    "type": "submit_tool_outputs"
  },
  "response_format": null,
  "started_at": 1,
  "status": "queued",
  "thread_id": "text",
  "tool_choice": null,
  "tools": [],
  "truncation_strategy": {
    "type": "auto",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  },
  "temperature": 1,
  "top_p": 1
}

Update a thread run’s details.

post

Updates the details of a thread run, modifying its status or context.

路径参数

threadIdstring必填

runIdstring必填

请求体

application/json

metadataobject可选

响应

200成功

application/json

idstring必填

assistant_idstring必填

cancelled_atnumber · 可为 null必填

completed_atnumber · 可为 null必填

created_atnumber必填

expires_atnumber · 可为 null必填

failed_atnumber · 可为 null必填

instructionsstring必填

max_completion_tokensnumber · 可为 null必填

max_prompt_tokensnumber · 可为 null必填

metadataany · 可为 null可选

modelstring必填

objectstring · enum必填可能的值:

parallel_tool_callsboolean必填

response_formatany · 可为 null可选

started_atnumber · 可为 null必填

statusstring · enum必填可能的值:

thread_idstring必填

tool_choiceany · 可为 null可选

temperaturenumber · 可为 null可选

top_pnumber · 可为 null可选

post

/threads/{threadId}/runs/{runId}

HTTPcURLJavaScriptPython

POST /threads/{threadId}/runs/{runId} HTTP/1.1
Host: api.aimlapi.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "metadata": {}
}

200成功

{
  "id": "text",
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "incomplete_details": {
    "reason": "max_completion_tokens"
  },
  "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": []
    },
    "type": "submit_tool_outputs"
  },
  "response_format": null,
  "started_at": 1,
  "status": "queued",
  "thread_id": "text",
  "tool_choice": null,
  "tools": [],
  "truncation_strategy": {
    "type": "auto",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  },
  "temperature": 1,
  "top_p": 1
}

Get details of a specific thread run.

get

Retrieves a single thread run by its ID, providing access to its execution details.

路径参数

threadIdstring必填

runIdstring必填

响应

200成功

application/json

idstring必填

assistant_idstring必填

cancelled_atnumber · 可为 null必填

completed_atnumber · 可为 null必填

created_atnumber必填

expires_atnumber · 可为 null必填

failed_atnumber · 可为 null必填

instructionsstring必填

max_completion_tokensnumber · 可为 null必填

max_prompt_tokensnumber · 可为 null必填

metadataany · 可为 null可选

modelstring必填

objectstring · enum必填可能的值:

parallel_tool_callsboolean必填

response_formatany · 可为 null可选

started_atnumber · 可为 null必填

statusstring · enum必填可能的值:

thread_idstring必填

tool_choiceany · 可为 null可选

temperaturenumber · 可为 null可选

top_pnumber · 可为 null可选

get

/threads/{threadId}/runs/{runId}

HTTPcURLJavaScriptPython

GET /threads/{threadId}/runs/{runId} HTTP/1.1
Host: api.aimlapi.com
Accept: */*

200成功

{
  "id": "text",
  "assistant_id": "text",
  "cancelled_at": 1,
  "completed_at": 1,
  "created_at": 1,
  "expires_at": 1,
  "failed_at": 1,
  "incomplete_details": {
    "reason": "max_completion_tokens"
  },
  "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": []
    },
    "type": "submit_tool_outputs"
  },
  "response_format": null,
  "started_at": 1,
  "status": "queued",
  "thread_id": "text",
  "tool_choice": null,
  "tools": [],
  "truncation_strategy": {
    "type": "auto",
    "last_messages": 1
  },
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1
  },
  "temperature": 1,
  "top_p": 1
}