{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Threads API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Threads", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Gets Chat Message Read Receipts For A Thread", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/chat/threads/:chatThreadId/readReceipts", "params": [ { "name": "chatThreadId", "value": "", "type": "path", "description": "Thread id to get the chat message read receipts for." }, { "name": "maxPageSize", "value": "", "type": "query", "description": "The maximum number of chat message read receipts to be returned per page." }, { "name": "skip", "value": "", "type": "query", "description": "Skips chat message read receipts up to a specified position in response." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of API to invoke." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Sends A Read Receipt Event To A Thread, On Behalf Of A User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chat/threads/:chatThreadId/readReceipts", "params": [ { "name": "chatThreadId", "value": "", "type": "path", "description": "Thread id to send the read receipt event to." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of API to invoke." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The List Of Chat Threads Of A User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/chat/threads", "params": [ { "name": "maxPageSize", "value": "", "type": "query", "description": "The maximum number of chat threads returned per page." }, { "name": "startTime", "value": "", "type": "query", "description": "The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of API to invoke." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Creates A Chat Thread", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/chat/threads", "headers": [ { "name": "repeatability-request-id", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "Version of API to invoke." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets A Chat Thread S Properties", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/chat/threads/:chatThreadId", "params": [ { "name": "chatThreadId", "value": "", "type": "path", "description": "Id of the thread." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of API to invoke." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Updates A Thread S Properties", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/chat/threads/:chatThreadId", "params": [ { "name": "chatThreadId", "value": "", "type": "path", "description": "The id of the thread to update." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of API to invoke." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Deletes A Thread", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/chat/threads/:chatThreadId", "params": [ { "name": "chatThreadId", "value": "", "type": "path", "description": "Id of the thread to be deleted." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of API to invoke." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Post Threads", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads" }, "docs": "Creates a new thread. Threads contain messages and can be run by assistants." }, { "info": { "name": "Microsoft Azure Get Threads Threadid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to retrieve information about." } ] }, "docs": "Gets information about an existing thread." }, { "info": { "name": "Microsoft Azure Post Threads Threadid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:threadId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to modify." } ] }, "docs": "Modifies an existing thread." }, { "info": { "name": "Microsoft Azure Delete Threads Threadid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/threads/:threadId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to delete." } ] }, "docs": "Deletes an existing thread." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/messages", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to list messages from." }, { "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 messages that exist on a thread." }, { "info": { "name": "Microsoft Azure Post Threads Threadid Messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:threadId/messages", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to create the new message on." } ] }, "docs": "Creates a new message on a specified thread." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Messages Messageid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/messages/:messageId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to retrieve the specified message from." }, { "name": "messageId", "value": "", "type": "path", "description": "The ID of the message to retrieve from the specified thread." } ] }, "docs": "Gets an existing message from an existing thread." }, { "info": { "name": "Microsoft Azure Post Threads Threadid Messages Messageid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:threadId/messages/:messageId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread containing the specified message to modify." }, { "name": "messageId", "value": "", "type": "path", "description": "The ID of the message to modify on the specified thread." } ] }, "docs": "Modifies an existing message on an existing thread." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Messages Messageid Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/messages/:messageId/files", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread containing the message to list files from." }, { "name": "messageId", "value": "", "type": "path", "description": "The ID of the message to list files from." }, { "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 previously uploaded files associated with a message from a thread." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Messages Messageid Files Fileid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/messages/:messageId/files/:fileId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread containing the message to get information from." }, { "name": "messageId", "value": "", "type": "path", "description": "The ID of the message to get information from." }, { "name": "fileId", "value": "", "type": "path", "description": "The ID of the file to get information about." } ] }, "docs": "Gets information about a file attachment to a message within a thread." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Runs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/runs", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to list runs from." }, { "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 runs for a specified thread." }, { "info": { "name": "Microsoft Azure Post Threads Threadid Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:threadId/runs", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to run." } ] }, "docs": "Creates a new run for an assistant thread." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Runs Runid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/runs/:runId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread to retrieve run information from." }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the thread to retrieve information about." } ] }, "docs": "Gets an existing run from an existing thread." }, { "info": { "name": "Microsoft Azure Post Threads Threadid Runs Runid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:threadId/runs/:runId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread associated with the specified run." }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the run to modify." } ] }, "docs": "Modifies an existing thread run." }, { "info": { "name": "Microsoft Azure Post Threads Threadid Runs Runid Cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:threadId/runs/:runId/cancel", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread being run." }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the run to cancel." } ] }, "docs": "Cancels a run of an in progress thread." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Runs Runid Steps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/runs/:runId/steps", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread that was run." }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the run to list steps from." }, { "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 run steps from a thread run." }, { "info": { "name": "Microsoft Azure Get Threads Threadid Runs Runid Steps Stepid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/threads/:threadId/runs/:runId/steps/:stepId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread that was run." }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the specific run to retrieve the step from." }, { "name": "stepId", "value": "", "type": "path", "description": "The ID of the step to retrieve information about." } ] }, "docs": "Gets a single run step from a thread run." }, { "info": { "name": "Microsoft Azure Post Threads Threadid Runs Runid Submit Tool Outputs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/:threadId/runs/:runId/submit_tool_outputs", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The ID of the thread that was run." }, { "name": "runId", "value": "", "type": "path", "description": "The ID of the run that requires tool outputs." } ] }, "docs": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'." }, { "info": { "name": "Microsoft Azure Post Threads Runs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/threads/runs" }, "docs": "Creates a new assistant thread and immediately starts a run using that new thread." } ] } ], "bundled": true }