Where's the REST API docs for the new Azure AI Agents?

dennisking2 5

Existing REST API calls using Assistants API no longer works with Agents created in Azure AI. Where's the REST API docs for Agents?

kothapally Snigdha 1,620 Reputation points Microsoft Vendor

2025-02-18T01:02:38.1866667+00:00

Hi Dennis King II,

The REST API documentation for the Azure AI Agent Service can be found in the Azure AI services documentation. The Azure AI services provide a variety of APIs, including those specifically for the Azure AI Agent Service. You can explore the API reference to find the necessary details for using the Agents.

Kindly refer these https://learn.microsoft.com/en-us/rest/api/aiservices/

For more Information have a look once these Azure AI services Blog
dennisking2 5 Reputation points

2025-02-18T16:47:52.5733333+00:00

Maybe I'm missing something, but I cannot find the REST API documentation listed anywhere there for agents? I'm specifically looking for the endpoints and schema needed for creating and running a thread, with a message body included in the payload. What am I missing?
dennisking2 5 Reputation points

2025-02-18T16:54:12.5233333+00:00

When I try to use the same schema from the assistants API, I get a 404 that suggests the assistant cannot be found:

But I know that's not true because:
kothapally Snigdha 1,620 Reputation points Microsoft Vendor

2025-02-21T00:58:42+00:00
Hi Dennis King II,

Double-check that the assistant ID you're using is correct and that it matches the ID listed in your OpenAI account.

Use the API to list all the assistants you have created. This can help confirm whether the assistant you're trying to use exists1.

Ensure that you're using the correct API key and that it has the necessary permissions.

Make sure you're including the required headers, such as OpenAI-Beta: assistants=v2 if you're using the beta version of the API.

Sometimes, issues can arise if there are pending updates or changes to your account. Check your account status and any recent changes.

I hope these helps you. Thankyou!
kothapally Snigdha 1,620 Reputation points Microsoft Vendor

2025-02-21T21:47:16.38+00:00

Hi Dennis King II,

Following up to see if the response was helpful.
dennisking2 5 Reputation points

2025-02-24T14:36:28.1666667+00:00

I didn't have the OpenAI-Beta header actually, but I did add that and tested it and got the same result.

When I do a get call to list the assistants, the returned list of assistants includes the 1st assistant I created BEFORE the new "Agents" showed up in our Azure AI Foundry.

None of the agents I've created are returned in the GET API call:
dennisking2 5 Reputation points

2025-02-24T14:41:47.8766667+00:00

Previous post was duplicated so I removed this posts content.
kothapally Snigdha 1,620 Reputation points Microsoft Vendor

2025-02-25T18:15:21.33+00:00
Hi Dennis King II,

Can you please check once.

Ensure you're using the correct endpoint for listing agents.

Ensure your agents have the correct permissions to be listed.

please Ensure you're using the correct version that supports agents.

Confirm agents were properly created and registered.

If applicable, ensure no filters or flags are hiding the agents.

I hope these helps you Thank you!
dennisking2 5 Reputation points

2025-02-26T16:07:32.3733333+00:00
What IS the correct endpoint? Would they be any different than the assistants REST API docs? Is it just:

https://(OUR RESOURCE).openai.azure.com/openai/assistants

And what API version should I be using? Is it:

"2024-08-01-preview"?

Other questions:

Where would I even set filters or flags to hide agents?

What permissions do agents need to be listed?
kothapally Snigdha 1,620 Reputation points Microsoft Vendor

2025-02-26T20:38:16.5633333+00:00
Hi Dennis King II,

The correct endpoint for accessing the Assistants API on Azure OpenAI depends on your specific resource configuration.

https://<YourResourceName>.cognitiveservices.azure.com/

The API version you should use is indeed 2024-08-01-preview for the Assistants API on Azure OpenAI. This is the latest preview version as of your current date (2025-02-26). Always check the Azure OpenAI documentation for updates.

Currently, the Assistants API does not provide built-in functionality to filter or hide agents directly via API parameters. If you need to hide or filter agents, you would typically handle this on the client side by:

Fetching the list of agents.

Applying your own logic to filter or hide specific agents based on criteria (e.g., metadata, tags, or custom properties).

To list agents, the API key or identity used must have the appropriate permissions. Typically, this requires:

Cognitive Services OpenAI User role or higher on the Azure OpenAI resource.

Ensure the API key or identity has access to the specific resource and endpoint.

I hope these helps you Thank you!
dennisking2 5 Reputation points

2025-02-27T13:44:56.13+00:00
Okay. I think we're heading in the wrong direction here. I really do appreciate your help, but I don't feel you're hearing me.

The endpoint you suggested is invalid, and also doesn't align with the Assistants API documentation.

I only asked about specific permissions agents should have because you said:

Ensure your agents have the correct permissions to be listed.

If you're referring to identity permissions, you can see I already have the correct permissions because I'm making successful calls (albeit the "Agent" being returned is the first assistant I created before our interface changed to "Agents", which is no longer accessible).

I only asked about filtering or flags because you said:

If applicable, ensure no filters or flags are hiding the agents

Since there is no filtering or flagging and you can see from the screenshots what I'm doing, that question just caused more confusion.

So let's reset... and start over if possible?

In all my screenshots above, you can see that my endpoint for viewing assistants is working. The problem is, it returns an assistant ID that existed BEFORE the interface in Azure AI Foundry changed to say AGENTS instead of ASSISTANTS. When that happened:

My previous assistant (that you can see returns in my GET Assistants call above) is completely gone from the UI.

I've created new assistants (or Agents as they're now called), and NONE of those are returned in the get Assistants API)

All other HTTP requests to my existing AGENTS fail, claiming there is no Assistant

The above points can be validated with my screenshots added in an earlier comment.

And I'm back to my original question, where is the REST API documentation specific to the new Agents? Because it's no where to be found here where the Agents documentation is. and the existing API documentation for Assistants is not working with Agents I've created.

If the answer is simply "This is all in preview and we don't yet have the documentation," that's totally fine with me. At least I know I can work on other things instead of wasting both yours and my time with further questions.

Thanks,

Dennis

Share via

Where's the REST API docs for the new Azure AI Agents?

Your answer