How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Assistants API

The Assistants API from Microsoft Azure — 20 operation(s) for assistants.

Microsoft Azure Assistants API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Assistants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 34 operations across 20 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

34 operations 20 paths 47 schemas 5 DELETE16 GET13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 34

Across 20 paths, the API surfaces 34 operations — 5 DELETE, 16 GET, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Assistants 34
GET
/assistants
Microsoft Azure Get Assistants
microsoftAzureListassistants 4 params → 200
POST
/assistants
Microsoft Azure Post Assistants
microsoftAzureCreateassistant body → 200
GET
/assistants/{assistantId}
Microsoft Azure Get Assistants Assistantid
microsoftAzureGetassistant 1 param → 200
POST
/assistants/{assistantId}
Microsoft Azure Post Assistants Assistantid
microsoftAzureModifyassistant 1 param body → 200
DELETE
/assistants/{assistantId}
Microsoft Azure Delete Assistants Assistantid
microsoftAzureDeleteassistant 1 param → 200
GET
/assistants/{assistantId}/files
Microsoft Azure Get Assistants Assistantid Files
microsoftAzureListassistantfiles 5 params → 200
POST
/assistants/{assistantId}/files
Microsoft Azure Post Assistants Assistantid Files
microsoftAzureCreateassistantfile 1 param body → 200
GET
/assistants/{assistantId}/files/{fileId}
Microsoft Azure Get Assistants Assistantid Files Fileid
microsoftAzureGetassistantfile 2 params → 200
DELETE
/assistants/{assistantId}/files/{fileId}
Microsoft Azure Delete Assistants Assistantid Files Fileid
microsoftAzureDeleteassistantfile 2 params → 200
GET
/assistants/{assistant_id}
Microsoft Azure Retrieves An Assistant
microsoftAzureGetAssistant 2 params → 200
DELETE
/assistants/{assistant_id}
Microsoft Azure Delete An Assistant
microsoftAzureDeleteAssistant 2 params → 200
POST
/threads
Microsoft Azure Create A Thread
microsoftAzureCreateThread 1 param body → 200
GET
/threads/{thread_id}
Microsoft Azure Retrieves A Thread
microsoftAzureGetThread 2 params → 200
POST
/threads/{thread_id}
Microsoft Azure Modifies A Thread
microsoftAzureModifyThread 2 params body → 200
DELETE
/threads/{thread_id}
Microsoft Azure Delete A Thread
microsoftAzureDeleteThread 2 params → 200
GET
/threads/{thread_id}/messages
Microsoft Azure Returns A List Of Messages For A Given Thread
microsoftAzureListMessages 6 params → 200
POST
/threads/{thread_id}/messages
Microsoft Azure Create A Message
microsoftAzureCreateMessage 2 params body → 200
GET
/threads/{thread_id}/messages/{message_id}
Microsoft Azure Retrieve A Message
microsoftAzureGetMessage 3 params → 200
POST
/threads/{thread_id}/messages/{message_id}
Microsoft Azure Modifies A Message
microsoftAzureModifyMessage 3 params body → 200
POST
/threads/runs
Microsoft Azure Create A Thread And Run It In One Request
microsoftAzureCreateThreadAndRun 1 param body → 200
GET
/threads/{thread_id}/runs
Microsoft Azure Returns A List Of Runs Belonging To A Thread
microsoftAzureListRuns 6 params → 200
POST
/threads/{thread_id}/runs
Microsoft Azure Create A Run
microsoftAzureCreateRun 2 params body → 200
GET
/threads/{thread_id}/runs/{run_id}
Microsoft Azure Retrieves A Run
microsoftAzureGetRun 3 params → 200
POST
/threads/{thread_id}/runs/{run_id}
Microsoft Azure Modifies A Run
microsoftAzureModifyRun 3 params body → 200
POST
/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
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 Comp…
microsoftAzureSubmitToolOutputsToRun 3 params body → 200
POST
/threads/{thread_id}/runs/{run_id}/cancel
Microsoft Azure Cancels A Run That Is in Progress
microsoftAzureCancelRun 3 params → 200
GET
/threads/{thread_id}/runs/{run_id}/steps
Microsoft Azure Returns A List Of Run Steps Belonging To A Run
microsoftAzureListRunSteps 7 params → 200
GET
/threads/{thread_id}/runs/{run_id}/steps/{step_id}
Microsoft Azure Retrieves A Run Step
microsoftAzureGetRunStep 4 params → 200
GET
/assistants/{assistant_id}/files
Microsoft Azure Returns A List Of Assistant Files
microsoftAzureListAssistantFiles 6 params → 200
POST
/assistants/{assistant_id}/files
Microsoft Azure Create An Assistant File By Attaching A [file] Docs Api Reference Files To An [assistant] Docs Api Reference Assistants
microsoftAzureCreateAssistantFile 2 params body → 200
GET
/assistants/{assistant_id}/files/{file_id}
Microsoft Azure Retrieves An Assistantfile
microsoftAzureGetAssistantFile 3 params → 200
DELETE
/assistants/{assistant_id}/files/{file_id}
Microsoft Azure Delete An Assistant File
microsoftAzureDeleteAssistantFile 3 params → 200
GET
/threads/{thread_id}/messages/{message_id}/files
Microsoft Azure Returns A List Of Message Files
microsoftAzureListMessageFiles 7 params → 200
GET
/threads/{thread_id}/messages/{message_id}/files/{file_id}
Microsoft Azure Retrieves A Message File
microsoftAzureGetMessageFile 4 params → 200

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are runObject (18 properties), runStepObject (15 properties), Assistant (10 properties), assistantObject (10 properties). Each schema is shown below with its type and property counts.

listRunsResponse
object
5 properties 5 required
modifyRunRequest
object
1 property
runStepObject
object
Represents a step in execution of a run.
15 properties 15 required
createRunRequest
object
5 properties 2 required
createMessageRequest
object
4 properties 2 required
messageContentImageFileObject
object
References an image [File](/docs/api-reference/files) in the content of a message.
2 properties 2 required
runStepDetailsToolCallsFunctionObject
object
3 properties 3 required
listMessageFilesResponse
object
5 properties 6 required
AssistantFileDeletionStatus
object
The status of an assistant file deletion operation.
3 properties 3 required
AssistantCreationOptions
object
The request details to use when creating a new assistant.
7 properties 1 required
deleteThreadResponse
object
3 properties 3 required
modifyMessageRequest
object
1 property
Assistant
object
Represents an assistant that can call the model and use tools.
10 properties 10 required
runStepDetailsMessageCreationObject
object
Details of the message creation by the run step.
2 properties 2 required
createAssistantFileRequest
object
1 property 1 required
assistantToolsFunction
object
2 properties 2 required
listAssistantFilesResponse
object
5 properties 6 required
createThreadAndRunRequest
object
6 properties 2 required
threadObject
object
Represents a thread that contains [messages](/docs/api-reference/messages).
4 properties 4 required
assistantToolsCode
object
1 property 1 required
AssistantModificationOptions
object
The request details to use when modifying an existing assistant.
7 properties
ToolDefinition
object
An abstract representation of an input tool definition that an assistant can use.
1 property 1 required
assistantFileObject
object
A list of [Files](/docs/api-reference/files) attached to an assistant.
4 properties 4 required
chatCompletionFunctionParameters
object
The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema…
messageContentTextObject
object
The text content that is part of a message.
2 properties 2 required
runStepDetailsToolCallsCodeOutputImageObject
object
2 properties 2 required
modifyThreadRequest
object
1 property
submitToolOutputsRunRequest
object
1 property 1 required
deleteAssistantFileResponse
object
Deletes the association between the assistant and the file, but does not delete the [File](/docs/api-reference/files) object itself.
3 properties 3 required
listRunStepsResponse
object
5 properties 5 required
messageContentTextAnnotationsFileCitationObject
object
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant u…
5 properties 5 required
runObject
object
Represents an execution run on a [thread](/docs/api-reference/threads).
18 properties 18 required
AssistantDeletionStatus
object
The status of an assistant deletion operation.
3 properties 3 required
listMessagesResponse
object
5 properties 5 required
runToolCallObject
object
Tool call objects
3 properties 3 required
runStepDetailsToolCallsCodeObject
object
Details of the Code Interpreter tool call the run step was involved in.
3 properties 3 required
runStepDetailsToolCallsCodeOutputLogsObject
object
Text output from the Code Interpreter tool call as part of a run step.
2 properties 2 required
assistantToolsRetrieval
object
1 property 1 required
messageContentTextAnnotationsFilePathObject
object
A URL for the file that's generated when the assistant used the codeinterpreter tool to generate a file.
5 properties 5 required
messageObject
object
Represents a message within a [thread](/docs/api-reference/threads).
10 properties 10 required
assistantObject
object
Represents an assistant that can call the model and use tools.
10 properties 10 required
runStepDetailsToolCallsObject
object
Details of the tool call.
2 properties 2 required
runStepDetailsToolCallsRetrievalObject
object
3 properties 3 required
messageFileObject
object
A list of files attached to a message.
4 properties 4 required
AssistantFile
object
Information about a file attached to an assistant, as used by tools that can read files.
4 properties 4 required
deleteAssistantResponse
object
3 properties 3 required
createThreadRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-assistants-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Assistants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.