{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Assistants API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Assistants", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Assistants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assistants", "params": [ { "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." }, { "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." }, { "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." }, { "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." } ] }, "docs": "Gets a list of assistants that were previously created." }, { "info": { "name": "Microsoft Azure Post Assistants", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assistants" }, "docs": "Creates a new assistant." }, { "info": { "name": "Microsoft Azure Get Assistants Assistantid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assistants/:assistantId", "params": [ { "name": "assistantId", "value": "", "type": "path", "description": "The ID of the assistant to retrieve." } ] }, "docs": "Retrieves an existing assistant." }, { "info": { "name": "Microsoft Azure Post Assistants Assistantid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assistants/:assistantId", "params": [ { "name": "assistantId", "value": "", "type": "path", "description": "The ID of the assistant to modify." } ] }, "docs": "Modifies an existing assistant." }, { "info": { "name": "Microsoft Azure Delete Assistants Assistantid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/assistants/:assistantId", "params": [ { "name": "assistantId", "value": "", "type": "path", "description": "The ID of the assistant to delete." } ] }, "docs": "Deletes an assistant." }, { "info": { "name": "Microsoft Azure Get Assistants Assistantid Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assistants/:assistantId/files", "params": [ { "name": "assistantId", "value": "", "type": "path", "description": "The ID of the assistant to retrieve the list of attached files for." }, { "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." }, { "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." }, { "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." }, { "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." } ] }, "docs": "Gets a list of files attached to a specific assistant, as used by tools that can read files." }, { "info": { "name": "Microsoft Azure Post Assistants Assistantid Files", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assistants/:assistantId/files", "params": [ { "name": "assistantId", "value": "", "type": "path", "description": "The ID of the assistant to attach the file to." } ] }, "docs": "Attaches a previously uploaded file to an assistant for use by tools that can read files." }, { "info": { "name": "Microsoft Azure Get Assistants Assistantid Files Fileid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assistants/:assistantId/files/:fileId", "params": [ { "name": "assistantId", "value": "", "type": "path", "description": "The ID of the assistant associated with the attached file." }, { "name": "fileId", "value": "", "type": "path", "description": "The ID of the file to retrieve." } ] }, "docs": "Retrieves a file attached to an assistant." }, { "info": { "name": "Microsoft Azure Delete Assistants Assistantid Files Fileid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/assistants/:assistantId/files/:fileId", "params": [ { "name": "assistantId", "value": "", "type": "path", "description": "The ID of the assistant from which the specified file should be unlinked." }, { "name": "fileId", "value": "", "type": "path", "description": "The ID of the file to unlink from the specified assistant." } ] }, "docs": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read
files." }, { "info": { "name": "Microsoft Azure Retrieves An Assistant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assistants/:assistant_id", "params": [ { "name": "assistant_id", "value": "", "type": "path", "description": "The ID of the assistant to retrieve." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Delete An Assistant", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/assistants/:assistant_id", "params": [ { "name": "assistant_id", "value": "", "type": "path", "description": "The ID of the assistant to delete." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create A Thread", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads", "params": [ { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Retrieves A Thread", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to retrieve." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Modifies A Thread", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to modify. Only the `metadata` can be modified." }, { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Delete A Thread", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to delete." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Returns A List Of Messages For A Given Thread", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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" }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create A Message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Retrieve A Message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Modifies A Message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create A Thread And Run It In One Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/runs", "params": [ { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Returns A List Of Runs Belonging To A Thread", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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" }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create A Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:thread_id/runs", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The ID of the thread to run." }, { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Retrieves A Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Modifies A Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure 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": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Cancels A Run That Is `in Progress`", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Returns A List Of Run Steps Belonging To A Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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" }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Retrieves A Run Step", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Returns A List Of Assistant Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assistants/:assistant_id/files", "params": [ { "name": "assistant_id", "value": "", "type": "path", "description": "The ID of the assistant the file 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" }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create An Assistant File By Attaching A [file] Docs Api Reference Files To An [assistant] Docs Api Reference Assistants", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assistants/:assistant_id/files", "params": [ { "name": "assistant_id", "value": "", "type": "path", "description": "The ID of the assistant for which to create a File.\n" }, { "name": "api-version", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Retrieves An Assistantfile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assistants/:assistant_id/files/:file_id", "params": [ { "name": "assistant_id", "value": "", "type": "path", "description": "The ID of the assistant who the file belongs to." }, { "name": "file_id", "value": "", "type": "path", "description": "The ID of the file we're getting." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Delete An Assistant File", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/assistants/:assistant_id/files/:file_id", "params": [ { "name": "assistant_id", "value": "", "type": "path", "description": "The ID of the assistant that the file belongs to." }, { "name": "file_id", "value": "", "type": "path", "description": "The ID of the file to delete." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Returns A List Of Message Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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" }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Retrieves A Message File", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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." }, { "name": "api-version", "value": "", "type": "query" } ] }, "docs": "Needs a more full description created." } ] } ], "bundled": true }