Microsoft Azure Threads API

The Threads API from Microsoft Azure — 16 operation(s) for threads.

Documentation GitHub OpenAPI

Operations 26

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /chat/threads/{chatThreadId}/readReceipts List read receipts in a chat thread · Microsoft Azure Gets Chat Message Read Receipts For A Thread #

Ask an LLM

“Who has read the latest messages in my Azure Communication Services chat thread?”

“Can I page through read receipts for a chat thread a few at a time?”

Tell an agent

Show the read receipts for chat thread {chatThreadId}.

List up to {maxPageSize} read receipts in chat thread {chatThreadId}.

POST /chat/threads/{chatThreadId}/readReceipts Mark a chat message as read · Microsoft Azure Sends A Read Receipt Event To A Thread, On Behalf Of A User #

Ask an LLM

“How do I tell a chat thread that a user has read a particular message?”

“Can I send a read receipt on behalf of a chat participant?”

Tell an agent

Send a read receipt for message {chatMessageId} in chat thread {chatThreadId}.

Mark chat message {chatMessageId} as read in thread {chatThreadId}.

POST /chat/threads Start a new chat thread · Microsoft Azure Creates A Chat Thread #

Ask an LLM

“How do I start a new group chat thread with a topic and participants?”

“Can I set a retention policy when I create a chat thread?”

Tell an agent

Create a chat thread with the topic {topic}.

Start a chat thread called {topic} and add participants {participants}.

GET /chat/threads List a user's chat threads · Microsoft Azure Gets The List Of Chat Threads Of A User #

Ask an LLM

“Which chat threads is the current user part of?”

“Can I only see chat threads that have been active since a certain time?”

Tell an agent

List the chat threads for the current chat user.

List my chat threads updated since {startTime}.

PATCH /chat/threads/{chatThreadId} Rename or update a chat thread · Microsoft Azure Updates A Thread S Properties #

Ask an LLM

“How do I change the topic of an existing chat thread?”

“Can I change the retention policy on a chat thread after it's created?”

Tell an agent

Change the topic of chat thread {chatThreadId} to {topic}.

Update the metadata on chat thread {chatThreadId} to {metadata}.

GET /chat/threads/{chatThreadId} Get a chat thread's properties · Microsoft Azure Gets A Chat Thread S Properties #

Ask an LLM

“What is the topic and creation info of a specific chat thread?”

“Where can I see who created a chat thread and when?”

Tell an agent

Get the properties of chat thread {chatThreadId}.

Show me the topic and metadata for chat thread {chatThreadId}.

DELETE /chat/threads/{chatThreadId} Delete a chat thread · Microsoft Azure Deletes A Thread #

Ask an LLM

“Can I permanently remove a Communication Services chat thread?”

“What happens when I delete a chat thread I no longer need?”

Tell an agent destructive · confirm first

Delete chat thread {chatThreadId}.

Remove the chat conversation {chatThreadId} entirely.

POST /threads Create an assistant thread · Microsoft Azure Post Threads #

Ask an LLM

“How do I create a conversation thread that an assistant can run on?”

“Can I seed a new assistant thread with starting messages?”

Tell an agent

Create a new empty assistant thread.

Create an assistant thread starting with the messages {messages}.

GET /threads/{threadId} Get an assistant thread · Microsoft Azure Get Threads Threadid #

Ask an LLM

“What details are stored on an existing assistant thread?”

“Can I look up an assistant thread by its ID to check its metadata?”

Tell an agent

Get assistant thread {threadId}.

Show the metadata on assistant thread {threadId}.

POST /threads/{threadId} Update an assistant thread's metadata · Microsoft Azure Post Threads Threadid #

Ask an LLM

“Can I tag an existing assistant thread with my own metadata?”

“Is it possible to change key-value metadata on an assistant thread?”

Tell an agent

Set the metadata on assistant thread {threadId} to {metadata}.

Modify assistant thread {threadId} with new metadata.

DELETE /threads/{threadId} Delete an assistant thread · Microsoft Azure Delete Threads Threadid #

Ask an LLM

“How do I delete an assistant conversation thread I'm done with?”

“Can I remove an old assistant thread and its history?”

Tell an agent destructive · confirm first

Delete assistant thread {threadId}.

Remove the assistant conversation {threadId}.

GET /threads/{threadId}/messages List messages on an assistant thread · Microsoft Azure Get Threads Threadid Messages #

Ask an LLM

“What messages have been posted to an assistant thread so far?”

“Can I list thread messages oldest-first and page with a cursor?”

Tell an agent

List the messages on assistant thread {threadId}.

Show the last {limit} messages on thread {threadId} in {order} order.

POST /threads/{threadId}/messages Add a message to an assistant thread · Microsoft Azure Post Threads Threadid Messages #

Ask an LLM

“How do I add a user message to an assistant thread?”

“Can I attach uploaded files when posting a message to a thread?”

Tell an agent

Post the message {content} as {role} on assistant thread {threadId}.

Add a user message {content} to thread {threadId} with files {file_ids}.

GET /threads/{threadId}/messages/{messageId} Get a message from an assistant thread · Microsoft Azure Get Threads Threadid Messages Messageid #

Ask an LLM

“Can I fetch one specific message from an assistant thread?”

“What role and content does a particular thread message have?”

Tell an agent

Get message {messageId} from assistant thread {threadId}.

Show the content of thread message {messageId} in {threadId}.

POST /threads/{threadId}/messages/{messageId} Update metadata on a thread message · Microsoft Azure Post Threads Threadid Messages Messageid #

Ask an LLM

“Can I add my own metadata to a message already on an assistant thread?”

“Is there a way to change key-value tags on an existing thread message?”

Tell an agent

Set metadata {metadata} on message {messageId} in thread {threadId}.

Modify message {messageId} on assistant thread {threadId}.

GET /threads/{threadId}/messages/{messageId}/files List files attached to a thread message · Microsoft Azure Get Threads Threadid Messages Messageid Files #

Ask an LLM

“Which files are attached to a message on an assistant thread?”

“Can I page through the file attachments of one thread message?”

Tell an agent

List the files attached to message {messageId} in thread {threadId}.

Show up to {limit} file attachments on message {messageId} of thread {threadId}.

GET /threads/{threadId}/messages/{messageId}/files/{fileId} Get a file attached to a thread message · Microsoft Azure Get Threads Threadid Messages Messageid Files Fileid #

Ask an LLM

“Can I look up details of one file attached to a thread message?”

“What do I get back about a single message file attachment?”

Tell an agent

Get file {fileId} attached to message {messageId} in thread {threadId}.

Show the attachment {fileId} on thread {threadId} message {messageId}.

GET /threads/{threadId}/runs List runs on an assistant thread · Microsoft Azure Get Threads Threadid Runs #

Ask an LLM

“How many times has an assistant been run on this thread?”

“Can I list a thread's runs newest-first?”

Tell an agent

List the runs for assistant thread {threadId}.

Show the {limit} most recent runs on thread {threadId}.

POST /threads/{threadId}/runs Run an assistant on an existing thread · Microsoft Azure Post Threads Threadid Runs #

Ask an LLM

“How do I have an assistant respond to the messages on a thread I already created?”

“Can I override the model or instructions for a single run?”

Tell an agent

Start a run of assistant {assistant_id} on thread {threadId}.

Run assistant {assistant_id} on thread {threadId} using model {model}.

GET /threads/{threadId}/runs/{runId} Check the status of a thread run · Microsoft Azure Get Threads Threadid Runs Runid #

Ask an LLM

“Has my assistant run finished or is it still in progress?”

“Is a run waiting on me to submit tool outputs?”

Tell an agent

Get run {runId} on thread {threadId}.

Check the status of assistant run {runId} in thread {threadId}.

POST /threads/{threadId}/runs/{runId} Update metadata on a thread run · Microsoft Azure Post Threads Threadid Runs Runid #

Ask an LLM

“Can I attach my own metadata to an assistant run after it starts?”

“Is it possible to relabel an existing run with key-value tags?”

Tell an agent

Set metadata {metadata} on run {runId} in thread {threadId}.

Modify assistant run {runId} on thread {threadId}.

POST /threads/{threadId}/runs/{runId}/cancel Cancel an in-progress thread run · Microsoft Azure Post Threads Threadid Runs Runid Cancel #

Ask an LLM

“How do I stop an assistant run that's taking too long?”

“Can I cancel a run while it's still in progress?”

Tell an agent destructive · confirm first

Cancel run {runId} on thread {threadId}.

Stop the in-progress assistant run {runId} in thread {threadId}.

GET /threads/{threadId}/runs/{runId}/steps List the steps of a thread run · Microsoft Azure Get Threads Threadid Runs Runid Steps #

Ask an LLM

“What steps did the assistant take during a run, like tool calls or message creation?”

“Can I page through a run's steps in ascending order?”

Tell an agent

List the steps of run {runId} on thread {threadId}.

Show the first {limit} steps of assistant run {runId} in thread {threadId}.

GET /threads/{threadId}/runs/{runId}/steps/{stepId} Get a single step of a thread run · Microsoft Azure Get Threads Threadid Runs Runid Steps Stepid #

Ask an LLM

“Can I inspect one specific step from an assistant run?”

“What details are recorded for an individual run step?”

Tell an agent

Get step {stepId} of run {runId} on thread {threadId}.

Show run step {stepId} from assistant run {runId} in {threadId}.

POST /threads/{threadId}/runs/{runId}/submit_tool_outputs Submit tool outputs to a waiting run · Microsoft Azure Post Threads Threadid Runs Runid Submit Tool Outputs #

Ask an LLM

“My run's status is requires_action — how do I send back the function results?”

“Where do I submit tool call outputs so the assistant run can continue?”

Tell an agent

Submit tool outputs {tool_outputs} to run {runId} on thread {threadId}.

Send the function call results {tool_outputs} back to waiting run {runId} in {threadId}.

POST /threads/runs Create a thread and run an assistant at once · Microsoft Azure Post Threads Runs #

Ask an LLM

“Can I create a new thread and start the assistant on it in a single call?”

“What's the quickest way to kick off an assistant conversation from scratch?”

Tell an agent

Create a new thread and immediately run assistant {assistant_id} on it.

Start a fresh thread {thread} and run assistant {assistant_id} on it in one step.

Microsoft Azure Threads API

Operations 26

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification