{ "opencollection": "1.0.0", "info": { "name": "OpenAI Assistants Threads API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Threads", "type": "folder" }, "items": [ { "info": { "name": "OpenAI Returns a list of message files.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/messages/:message_id/files", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread that the message and files belong to." }, { "name": "message_id", "value": "", "type": "path", "description": "The ID of the message that the files belongs to." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "order", "value": "", "type": "query", "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" }, { "name": "before", "value": "", "type": "query", "description": "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, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n" } ] }, "docs": "OpenAI Returns a list of message files." }, { "info": { "name": "OpenAI Retrieves a message file.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/messages/:message_id/files/:file_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to which the message and File belong." }, { "name": "message_id", "value": "", "type": "path", "description": "The ID of the message the file belongs to." }, { "name": "file_id", "value": "", "type": "path", "description": "The ID of the file being retrieved." } ] }, "docs": "OpenAI Retrieves a message file." }, { "info": { "name": "OpenAI Create a thread.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads", "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI Create a thread." }, { "info": { "name": "OpenAI Retrieves a thread.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to retrieve." } ] }, "docs": "OpenAI Retrieves a thread." }, { "info": { "name": "OpenAI Modifies a thread.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to modify. Only the `metadata` can be modified." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI Modifies a thread." }, { "info": { "name": "OpenAI Delete a thread.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.openai.com/v1/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to delete." } ] }, "docs": "OpenAI Delete a thread." }, { "info": { "name": "OpenAI Returns a list of messages for a given thread.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/messages", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the [thread](/docs/api-reference/threads) the messages belong to." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "order", "value": "", "type": "query", "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" }, { "name": "before", "value": "", "type": "query", "description": "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, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n" } ] }, "docs": "OpenAI Returns a list of messages for a given thread." }, { "info": { "name": "OpenAI Create a message.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/:thread_id/messages", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the [thread](/docs/api-reference/threads) to create a message for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI Create a message." }, { "info": { "name": "OpenAI Retrieve a message.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/messages/:message_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the [thread](/docs/api-reference/threads) to which this message belongs." }, { "name": "message_id", "value": "", "type": "path", "description": "The ID of the message to retrieve." } ] }, "docs": "OpenAI Retrieve a message." }, { "info": { "name": "OpenAI Modifies a message.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/:thread_id/messages/:message_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to which this message belongs." }, { "name": "message_id", "value": "", "type": "path", "description": "The ID of the message to modify." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI Modifies a message." }, { "info": { "name": "OpenAI Create a thread and run it in one request.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/runs", "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI Create a thread and run it in one request." }, { "info": { "name": "OpenAI Returns a list of runs belonging to a thread.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/runs", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread the run belongs to." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "order", "value": "", "type": "query", "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" }, { "name": "before", "value": "", "type": "query", "description": "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, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n" } ] }, "docs": "OpenAI Returns a list of runs belonging to a thread." }, { "info": { "name": "OpenAI Create a run.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/:thread_id/runs", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to run." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI Create a run." }, { "info": { "name": "OpenAI Retrieves a run.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/runs/:run_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the [thread](/docs/api-reference/threads) that was run." }, { "name": "run_id", "value": "", "type": "path", "description": "The ID of the run to retrieve." } ] }, "docs": "OpenAI Retrieves a run." }, { "info": { "name": "OpenAI Modifies a run.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/:thread_id/runs/:run_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the [thread](/docs/api-reference/threads) that was run." }, { "name": "run_id", "value": "", "type": "path", "description": "The ID of the run to modify." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI Modifies a run." }, { "info": { "name": "OpenAI When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/:thread_id/runs/:run_id/submit_tool_outputs", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the [thread](/docs/api-reference/threads) to which this run belongs." }, { "name": "run_id", "value": "", "type": "path", "description": "The ID of the run that requires the tool output submission." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OpenAI When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request." }, { "info": { "name": "OpenAI Cancels a run that is `in_progress`.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/threads/:thread_id/runs/:run_id/cancel", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to which this run belongs." }, { "name": "run_id", "value": "", "type": "path", "description": "The ID of the run to cancel." } ] }, "docs": "OpenAI Cancels a run that is `in_progress`." }, { "info": { "name": "OpenAI Returns a list of run steps belonging to a run.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/runs/:run_id/steps", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread the run and run steps belong to." }, { "name": "run_id", "value": "", "type": "path", "description": "The ID of the run the run steps belong to." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "order", "value": "", "type": "query", "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" }, { "name": "before", "value": "", "type": "query", "description": "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, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n" } ] }, "docs": "OpenAI Returns a list of run steps belonging to a run." }, { "info": { "name": "OpenAI Retrieves a run step.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/threads/:thread_id/runs/:run_id/steps/:step_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to which the run and run step belongs." }, { "name": "run_id", "value": "", "type": "path", "description": "The ID of the run to which the run step belongs." }, { "name": "step_id", "value": "", "type": "path", "description": "The ID of the run step to retrieve." } ] }, "docs": "OpenAI Retrieves a run step." } ] } ], "bundled": true }