OpenAI API参考文档 | OpenAI开发文档|OpenAI中文官方文档|ChatGPT中文版|ChatGPT教程

Run steps
Beta

Represents the steps (model and tool calls) taken during the run.source

Related guide: Assistants source

List run steps
Beta

get https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps

Returns a list of run steps belonging to a run.source

Path parameters

thread_id

stringsource

Required

The ID of the thread the run and run steps belong to.source

run_id

stringsource

Required

The ID of the run the run steps belong to.source

Query parameters

limit

integersource

Optional

Defaults to 20

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

order

stringsource

Optional

Defaults to desc

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

after

stringsource

Optional

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.source

before

stringsource

Optional

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.source

include[]

arraysource

Optional

A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.source

See the file search tool documentation for more information.source

Returns

A list of run step objects.source

Example request

1
2
3
4
curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/steps \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"

1
2
3
4
5
6
7
8
9
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)

1
2
3
4
5
6
7
8
9
10
11
12
import OpenAI from "openai";
const openai = new OpenAI();

async function main() {
  const runStep = await openai.beta.threads.runs.steps.list(
    "thread_abc123",
    "run_abc123"
  );
  console.log(runStep);
}

main();

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "object": "list",
  "data": [
    {
      "id": "step_abc123",
      "object": "thread.run.step",
      "created_at": 1699063291,
      "run_id": "run_abc123",
      "assistant_id": "asst_abc123",
      "thread_id": "thread_abc123",
      "type": "message_creation",
      "status": "completed",
      "cancelled_at": null,
      "completed_at": 1699063291,
      "expired_at": null,
      "failed_at": null,
      "last_error": null,
      "step_details": {
        "type": "message_creation",
        "message_creation": {
          "message_id": "msg_abc123"
        }
      },
      "usage": {
        "prompt_tokens": 123,
        "completion_tokens": 456,
        "total_tokens": 579
      }
    }
  ],
  "first_id": "step_abc123",
  "last_id": "step_abc456",
  "has_more": false
}

Retrieve run step
Beta

get https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}

Retrieves a run step.source

Path parameters

thread_id

stringsource

Required

The ID of the thread to which the run and run step belongs.source

run_id

stringsource

Required

The ID of the run to which the run step belongs.source

step_id

stringsource

Required

The ID of the run step to retrieve.source

Query parameters

include[]

arraysource

Optional

See the file search tool documentation for more information.source

Returns

The run step object matching the specified ID.source

Example request

1
2
3
4
curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/steps/step_abc123 \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"

1
2
3
4
5
6
7
8
9
10
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)

1
2
3
4
5
6
7
8
9
10
11
12
13
import OpenAI from "openai";
const openai = new OpenAI();

async function main() {
  const runStep = await openai.beta.threads.runs.steps.retrieve(
    "thread_abc123",
    "run_abc123",
    "step_abc123"
  );
  console.log(runStep);
}

main();

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "id": "step_abc123",
  "object": "thread.run.step",
  "created_at": 1699063291,
  "run_id": "run_abc123",
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "type": "message_creation",
  "status": "completed",
  "cancelled_at": null,
  "completed_at": 1699063291,
  "expired_at": null,
  "failed_at": null,
  "last_error": null,
  "step_details": {
    "type": "message_creation",
    "message_creation": {
      "message_id": "msg_abc123"
    }
  },
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 456,
    "total_tokens": 579
  }
}

The run step object
Beta

Represents a step in execution of a run.source

stringsource

The identifier of the run step, which can be referenced in API endpoints.source

object

stringsource

The object type, which is always thread.run.step.source

created_at

integersource

The Unix timestamp (in seconds) for when the run step was created.source

assistant_id

stringsource

The ID of the assistant associated with the run step.source

thread_id

stringsource

The ID of the thread that was run.source

run_id

stringsource

The ID of the run that this run step is a part of.source

type

stringsource

The type of run step, which can be either message_creation or tool_calls.source

status

stringsource

The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.source

step_details

objectsource

The details of the run step.source

last_error

object or nullsource

The last error associated with this run step. Will be null if there are no errors.source

expired_at

integer or nullsource

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.source

cancelled_at

integer or nullsource

The Unix timestamp (in seconds) for when the run step was cancelled.source

failed_at

integer or nullsource

The Unix timestamp (in seconds) for when the run step failed.source

completed_at

integer or nullsource

The Unix timestamp (in seconds) for when the run step completed.source

metadata

mapsource

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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.source

usage

object or nullsource

Usage statistics related to the run step. This value will be null while the run step's status is in_progress.source

OBJECT The run step object

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "id": "step_abc123",
  "object": "thread.run.step",
  "created_at": 1699063291,
  "run_id": "run_abc123",
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "type": "message_creation",
  "status": "completed",
  "cancelled_at": null,
  "completed_at": 1699063291,
  "expired_at": null,
  "failed_at": null,
  "last_error": null,
  "step_details": {
    "type": "message_creation",
    "message_creation": {
      "message_id": "msg_abc123"
    }
  },
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 456,
    "total_tokens": 579
  }
}

Run stepsBeta

List run stepsBeta

Path parameters

Query parameters

Returns

Retrieve run stepBeta

Path parameters

Query parameters

Returns

The run step objectBeta

Run steps
Beta

List run steps
Beta

Retrieve run step
Beta

The run step object
Beta