# Askpilot documentation The complete Askpilot docs as one file: the Introduction, the Developers section (the public API, and starting workflows through it) and the Ask AI page. Each page is also available on its own as Markdown at the same path with .md. Site: https://askpilot.com. Generated on the last docs build. --- # Askpilot documentation Learn how the Askpilot platform works and what you can do with it. ## What Askpilot does Askpilot is an agentic workflow execution platform. Write down a business process in the [PROCESS.md format](https://askpilot.com/process-md.html), the way you would explain it to a colleague, and Askpilot turns it into a workflow and runs it end to end. Connect the tools that you already use, such as your CRM, your inbox, your phone system, and your calendar, and Askpilot executes the work across them. You do not need to replace your current tool stack. Askpilot works as an intelligence layer on top of it. It takes a whole workflow off your team's hands, so your team can spend more of their time on customers. These docs explain everything you need to set up Askpilot and understand how it works. ## Your data Your data is never used to train Askpilot or the AI models that power it. The [Data Processing Addendum](https://askpilot.com/legal.html#data-processing-addendum) sets this out, along with how customer data is handled and which sub-processors are involved. ## For developers Askpilot has a public API, so your own systems can trigger any workflow. The [Developers](https://askpilot.com/docs/developers/) section explains how to get started with the API. --- # Askpilot Public API Askpilot lets you create and run workflows. Use our API to trigger workflows from your own systems. ## What you can do with the API With the API you can list the workflows in your organization and trigger any of them. That means a workflow you have set up in Askpilot can be started from your own systems: a CRM, a booking tool, an internal app or anything else you use. More capabilities are coming soon. To learn more about how workflows are started through the API, see the [Workflows](https://askpilot.com/docs/developers/workflows.html) page. ## Get your API key Keys are created and managed in the Askpilot app. Below is a step by step guide on how to create one and use it safely. 1. **Open the API settings.** In the Askpilot app, go to Settings → API. 2. **Create a key.** Click Create key, give it a name and select its scopes, then copy it straight away. The key is only shown once. To find a workflow's ID the key needs the `workflows:read` scope, and to start one it needs `workflows:write`. 3. **Send it as a Bearer token.** Put the key in the `Authorization` header of every request: `Authorization: Bearer `. 4. **Keep it secret.** Treat the key like a password. Load it from an environment variable or a secrets vault on your own servers, and never put it in client-side code, version control or logs. If a key is exposed, revoke it in Settings → API and create a new one. ## Use the API Every endpoint, with request and response examples, is in the reference. If you work with Python, an official SDK is available. - [API reference](https://public-api.askpilot.com/docs#/): Every endpoint, with request and response examples and a console to try calls. - [OpenAPI spec](https://public-api.askpilot.com/openapi.json): Import it into Postman, generate a client, or hand it to your AI agent. - [Python SDK](https://github.com/Askpilot-AI-Number/public-api-python-client-sdk): The official Python client. Install it with pip or uv. Have any questions about the API? Email [support@askpilot.com](mailto:support@askpilot.com). --- # Workflows On this page you can learn how to start an existing workflow through the API, and what the prerequisites are. ## How to start a workflow Starting a workflow through the API takes a few steps. Most of them happen in Askpilot, before you send a single request. 1. **Create the workflow in Askpilot.** The API can only start a workflow that already exists. If you do not have one yet, create it in Askpilot first, then come back here. 2. **Give it an API trigger.** A workflow can only be started from the API when **its trigger is set to API and it is switched on**. Without that trigger, a start request is refused. You can add the trigger in Workflows → Your workflow → Settings. 3. **Check its settings.** A start does not change anything about the workflow. It runs with the settings it already has in Askpilot: for the person who has access to it, with the sources selected for it, and with auto-run if enabled. You can see and change all of this in Workflows → Your workflow → Settings. 4. **Get its ID.** Before you start a workflow you need to get its ID. Call [List Workflows](https://public-api.askpilot.com/docs#/Workflows/list_workflows_v1_workflows_get) in the API reference: it returns the workflows in your organization with their IDs, and you can search by name. If you already know the ID, [Get Workflow](https://public-api.askpilot.com/docs#/Workflows/get_workflow_v1_workflows__workflow_id__get) returns that one workflow with its details: its trigger, sources, who has access and other settings. Both calls need a key with the `workflows:read` scope. 5. **Start it through the API.** Call [Start Workflow](https://public-api.askpilot.com/docs#/Workflows/start_workflow_v1_workflows__workflow_id__start_post) in the API reference with the workflow's ID. Askpilot opens a new session for the person with access and runs the workflow in it. The response includes the ID of that session. 6. **Start another workflow in the same session, if you need to.** With that session ID you can start another workflow in the same session instead of opening a new one. Keep in mind that the new workflow brings its own settings: its selected sources, its auto-run setting and everything else replace those of the workflow that started the session. --- # Learn anything about Askpilot in your AI agent. Open the whole documentation in Claude or ChatGPT and ask anything, or copy the Markdown and use it in any AI agent. You do not have to read these docs. Hand them to the AI agent you already use and ask it what you want to know: how a workflow is written, what starts a run, how to get an API key, or anything else you are interested in. Pick the agent below. - [Open in Claude](https://claude.ai/new?q=Read%20the%20whole%20Askpilot%20documentation%20at%20https%3A%2F%2Faskpilot.com%2Fdocs%2Fllms-full.txt%20so%20I%20can%20ask%20questions%20about%20it.): Opens a Claude chat with the whole Askpilot documentation loaded, so you can ask it anything. - [Open in ChatGPT](https://chatgpt.com/?hints=search&q=Read%20the%20whole%20Askpilot%20documentation%20at%20https%3A%2F%2Faskpilot.com%2Fdocs%2Fllms-full.txt%20so%20I%20can%20ask%20questions%20about%20it.): Opens a ChatGPT chat with the whole Askpilot documentation loaded, so you can ask it anything. - **Copy as Markdown**: Copies the whole documentation as Markdown text, to share with any AI agent. - [View as Markdown](https://askpilot.com/docs/llms-full.txt): Downloads the whole documentation as Markdown text, to share with any AI agent.