Skip to content

Comments

Add Agent API endpoints#249

Open
ta-dam wants to merge 2 commits intomainfrom
add-agent-api
Open

Add Agent API endpoints#249
ta-dam wants to merge 2 commits intomainfrom
add-agent-api

Conversation

@ta-dam
Copy link

@ta-dam ta-dam commented Feb 19, 2026

Added two Agent API endpoints to the docs.

  1. Trigger a workflow
  2. Get the results once the task is completed

@ta-dam ta-dam requested review from DeeJayTC and morsssss February 19, 2026 15:54
@shirgoldbird
Copy link
Member

@ta-dam, I just merged in a PR that updates our README with new guidance on how to run our AI review agents over documentation. Could you run this workflow on agent-api.mdx? Thanks!

@shirgoldbird
Copy link
Member

also tagging some API Core engineers to review the API spec

Copy link
Contributor

@morsssss morsssss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice! I left a couple of comments.

The DeepL Agent API is only available to a limited set of DeepL Agent subscribers. Contact your DeepL customer success manager or our support team to enable access for your account.
</Info>

Once enabled, follow the instructions in [Managing API keys](/docs/getting-started/managing-api-keys#basic-api-key-management)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you saying that people need to create a special API key to use the Agent API? If not, I don't think we need this part.

For more information on the DeepL Agent, visit the [HelpCenter](https://support.deepl.com/hc/en-us/categories/22974438575516-DeepL-Agent).

### Trigger a workflow
Workflows are triggered with the help of the workflow ID. For more information on how to obtain a workflow ID, see the [HelpCenter](https://support.deepl.com/hc/en-us/articles/25472835912348). If your workflow contains a variable, you need to add an input to your request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To avoid passive voice here, how about replacing this first sentence with "To trigger a workflow, you'll need a workflow ID".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also not sure what the last sentence means. I assume you mean that the variable should be sent in the input parameter? You could also say that this parameter is a dictionary mapping keys to values.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants