Commit Graph

24 Commits

Author SHA1 Message Date
Ethan Palm 06923841a4 Assistant message API v2 docs (#3047)
* Split assistant message into separate v1 and v2 pages

- Revert create-assistant-message.mdx to v1 content with updated
  OpenAPI path and note pointing users to the v2 page
- Add create-assistant-message-v2.mdx for the v2 endpoint with
  AI SDK v5 integration example
- Add v2 page to docs.json navigation (Assistant group)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* add v2 endpoint to discovery openAPI schema

* update v1 openapi frontmatter

* update v2 page

* add version info to v1

* remove duplicative callout

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 15:09:24 -08:00
Ethan Palm 5c379eac57 Clarify API key requirements on endpoint pages (#3015) 2026-01-30 17:13:48 -08:00
Ethan Palm 428d38fb9e Feedback fixes (#2603)
* add explanation of plausible server

* add info on aligning table columns

* clarify API keys

* add example API use cases

* update link to API auth

* remove passive voice
2026-01-08 10:12:33 -08:00
skeptrune 222fe874b4 fix: update API endpoint for assistant message integration (#2212) 2025-12-10 18:57:01 -08:00
Dean from Mintlify 16b96865cf Enabling MCP server on search documentation endpoint (#2133)
Testing out MCP servers on API routes that require authentication of some sort (in this case, a bearer token)
2025-12-08 17:08:51 -08:00
mintlify[bot] 4c764acc91 Remove x-mcp global enablement from OpenAPI examples (#2102)
* Update api-playground/openapi-setup.mdx

* Update fr/api-playground/openapi-setup.mdx

* Update es/api-playground/openapi-setup.mdx

* Update zh/api-playground/openapi-setup.mdx

* Update discovery-openapi.json

* Update es/discovery-openapi.json

* Update zh/discovery-openapi.json

* Update fr/discovery-openapi.json

* Update api-playground/openapi-setup.mdx

* Update fr/api-playground/openapi-setup.mdx

* Update es/api-playground/openapi-setup.mdx

* Update zh/api-playground/openapi-setup.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-12-06 17:40:08 -08:00
Ethan Palm c0e340dc8e Address feedback (#2058)
* clarify nav nesting

* specify AI SDK v4

* note nav limitations and add examples

* update param descriptions
2025-12-04 19:20:58 -08:00
mintlify[bot] 4c9687f3f9 Update discovery-openapi.json (#2044)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-12-04 09:49:50 -08:00
Ethan Palm 8f3b5ea930 API cleanup (#1600) 2025-10-22 17:56:51 -07:00
mintlify-development[bot] 4e914ef492 Update api-discovery endpoint to admin api (#1407)
* Update api-reference/agent/create-agent-job.mdx

* Update api-reference/agent/get-agent-job.mdx

* Update api-reference/agent/get-all-jobs.mdx

* Update api-reference/introduction.mdx

* Update api-reference/introduction.mdx

* Update discovery-openapi.json

* Update discovery-openapi.json

* Update admin-openapi.json

* Update api-reference/agent/create-agent-job.mdx

* feature: fix route, add details api key

* feature: rename domain / projectId plus copy

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
Co-authored-by: cdxker <denzell@mintlify.com>
2025-09-30 17:33:39 -07:00
Ethan Palm 09d28cbe23 Agent docs (#1351)
* update Slack app naming

* add agent page to nav

* create agent page

* add to common workflows

* remove passive voice

* add API workflow example

* add Slack to header exceptions

* revise intro

* adjust header depth for ToC

* clean up the prompts section

* add into to workflows section

* add broad examples

* update example workflows

* 💅

* add steps for connecting repos

* clean up some TODOs

* edit intro

* feature: rough draft of discovery agent routes. Copy is prone to change just copy / pasted

* feature: finalized rough draft of api spec. Cleaned up copy on the api reference page

* alphabetize endpoint groups

* writer -> agent

* add links to endpoint pages

* 💅

* add rate limit info

* spacing

* update availability

* concision

* update access requirements

---------

Co-authored-by: cdxker <fdenzell@gmail.com>
Co-authored-by: cdxker <denzell@mintlify.com>
2025-09-28 23:46:22 -07:00
Han Wang 11f81eca33 Simplify the endpoints 2025-08-10 13:30:15 -07:00
Han Wang 347f607ac6 Update API discovery name 2025-08-08 14:58:05 -07:00
Han Wang 98ed415c13 Update create assistant page 2025-08-08 14:57:09 -07:00
skeptrune b359742ba2 fix: add /docs prefix to openapi links since they aren't rewritten (#990) 2025-08-05 10:10:30 -07:00
skeptrune dd9c458a95 chore: Enhance OpenAPI documentation by adding required field formatting and providing a description for the bearerAuth security scheme. (#989) 2025-08-05 10:04:49 -07:00
Ethan Palm dfb51cb789 Add search endpoint (#987)
* Use sentence case for endpoints

* add search endpoint

* add link to search in API intro

* rename `/chat` to `/assistant`

* make it more clear which keys are for which endpoints

* remove redundant security
2025-08-04 18:33:35 -07:00
Ethan Palm 1523d12eec clarify what the domain identifier is (#981) 2025-08-01 17:04:59 -07:00
skeptrune cdca393da1 nick/fix assistant api url (#912)
* Refactor API endpoint to generate assistant messages with updated request and response structures

* Add Mintlify documentation and update API reference for assistant message generation

* Update OpenAPI specification for assistant message generation with new request structure and additional properties

* Add default values for threadId and messages in assistant message generation

* Add back the create topic and generate message pages

* fix: correct the openapi url for assistant
2025-07-14 17:23:02 -07:00
skeptrune 3eb582f5b8 #3707 Refactor API endpoint to generate assistant messages with updated request and response structures (#905)
* Refactor API endpoint to generate assistant messages with updated request and response structures

* Add Mintlify documentation and update API reference for assistant message generation

* Update OpenAPI specification for assistant message generation with new request structure and additional properties

* Add default values for threadId and messages in assistant message generation

* Add back the create topic and generate message pages
2025-07-11 16:44:51 -07:00
Han Wang 4e61c64d68 Update to assistant 2025-05-26 00:27:41 -07:00
Han Wang 688aa58d1e Update description for endpoints 2025-04-20 22:59:47 -07:00
Han Wang 8452ad641b Add x-mcp enabled 2025-04-06 21:53:22 -07:00
Mayank Shouche 461d6bf0b2 document discovery api (#411)
* wip

* update spec

* clarify base url

* more clarification

* move discovery api

---------

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
2025-01-02 13:37:43 -08:00