> ## Documentation Index > Fetch the complete documentation index at: https://docs.getunblocked.com/llms.txt > Use this file to discover all available pages before exploring further. # Quickstart for the Unblocked API The Unblocked API is a REST API that allows you to retrieve context from your connected data sources, add documents to Unblocked, and ask questions about your codebase programmatically. If you are deciding between the REST API, MCP, and the Unblocked CLI, see [Programmatic access to Unblocked](/programmatic-access). ## Create an API Token Unblocked supports two types of API tokens for authentication: Personal Access Tokens are scoped to your individual account and are ideal for personal automation, testing, and development workflows. Personal Access Tokens have a limit of **1,000 API calls per day**. See [Rate limits](/api-reference/rate-limits). In the [Unblocked web app](/using-unblocked/on-the-web), click on **Settings** --> **API Tokens**. In the **Personal API Tokens** section, click on **Create Token**. Personal Token[] Fill out the token name. You can also limit the data sources that the token will have access to in the list under **Data Sources**. Personal Token[] Copy the resulting API token. Personal Token[] Team Access Tokens can access every document in the data sources selected when the token is created. Select only the data sources this integration needs, store the token in a secret manager, and rotate it regularly. In the [Unblocked web app](/using-unblocked/on-the-web), click on **Settings** --> **API Tokens**. In the **Team API Tokens** section, click on **Create Token**. Team Token[] Fill out the token name. You can also limit the data sources that the token will have access to in the list under **Data Sources**. Team Token[] Copy the resulting API token. Team Token[] All tokens should be provided with each request to the Unblocked API using the `Authorization: Bearer ` header to authenticate the request. ## Retrieve Context The Context API retrieves information from the code, pull requests, issues, messages, and documentation connected to Unblocked. Context requests are synchronous. Use the research endpoint when you want a synthesized answer from several source types: ```bash theme={null} curl --request POST \ --url https://getunblocked.com/api/v1/context/research \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "query": "How does the user authentication system work?", "instruction": "Focus on the current implementation and the decisions behind it.", "effort": "medium" }' ``` The response contains a Markdown summary and the sources that support it: ```json theme={null} { "summary": "The authentication system uses short-lived access tokens...", "sources": [ { "content": "The access token is validated before...", "title": "Add short-lived access tokens", "url": "https://github.com/yourorg/yourrepo/pull/123", "sourceType": "pull_request", "provider": "github" } ], "effort": "medium" } ``` Choose a focused endpoint when you do not need a synthesized answer: | Endpoint | Use it to | | - | - | | `POST /context/research` | Research across all connected source types and return a summary with supporting sources. | | `POST /context/search/code` | Search connected source code. | | `POST /context/search/documentation` | Search connected documentation and knowledge bases. | | `POST /context/search/issues` | Search connected issue trackers. | | `POST /context/search/messages` | Search connected messaging platforms. | | `POST /context/search/prs` | Search pull requests. | | `POST /context/query/issues` | Retrieve issues that match natural-language criteria and optional project or person filters. | | `POST /context/query/prs` | Retrieve pull requests that match natural-language criteria and optional repository or person filters. | | `POST /context/get/urls` | Retrieve content from known URLs. | Search endpoints accept a `query` and optional `instruction`. Query endpoints accept a `query` plus optional `projects` and `userName` filters. The URL endpoint accepts a non-empty `urls` array. ## Create a Collection To add your own documents, first create a collection. A collection in Unblocked is a group of related documents from various data sources, such as customer support tools, knowledge bases, and internal wikis. Multiple collections can be created to manage documents from different sources. ```bash theme={null} curl --request POST \ --url https://getunblocked.com/api/v1/collections \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "name": "Apollo", "description": "Documents from the Apollo customer support tool including support responses.", "iconUrl": "https://my.company.com/apollo/logo.svg" }' ``` The Unblocked API will respond with the newly created collection along with an ID. This ID uniquely identifies the collection, and will be used for adding documents to Unblocked. ```json theme={null} { "id": "12345678-abcd-123456789-123456789abc", "name": "Apollo", "description": "Documents from the Apollo customer support tool including support responses.", "iconUrl": "https://my.company.com/apollo/logo.svg" } ``` Collections can also be created in the Unblocked web app. Once you've signed in, click **Data Sources** in the sidebar, and then the **Add Data Sources** section. Scroll to the Custom section and select **Public API Collection**. ## Add a Document Add a document to the collection using the collection's ID. In addition to the collection ID, provide a title, a body (in plain text or Markdown), and a URI for the document. A document is uniquely identified by its URI. The URI will be used to link to the source of a reference in an answer. ```bash theme={null} curl --request PUT \ --url https://getunblocked.com/api/v1/documents \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "collectionId": "12345678-abcd-123456789-123456789abc", "title": "Password Reset Guide", "body": "To reset your password, visit ...", "uri": "https://my.company.com/apollo/ticket/123456" }' ``` ## Get Answers The Answers API allows you to programmatically ask questions about your codebase and receive answers from Unblocked. The API uses an asynchronous pattern where you submit a question and then poll for the response. Responses are in Markdown format. The Answers API is currently limited to 1,000 questions per day per team. See [Rate limits](/api-reference/rate-limits). ### Submit a Question First, submit your question using a unique `questionId` (must be a globally unique UUID): ```bash theme={null} curl --request PUT \ --url https://getunblocked.com/api/v1/answers/12345678-abcd-123456789-123456789abc \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "question": "How does the user authentication system work?" }' ``` The API will respond with a `204 No Content` status, indicating the question has been queued for processing. ### Poll for the Answer Use the same `questionId` to poll for the answer: ```bash theme={null} curl --request GET \ --url https://getunblocked.com/api/v1/answers/12345678-abcd-123456789-123456789abc \ --header 'Authorization: Bearer ' ``` While processing, the API returns: ```json theme={null} { "state": "processing" } ``` Once complete, the API returns the answer with references: ```json theme={null} { "state": "complete", "result": { "answer": "The user authentication system uses JWT tokens... ", "references": [ { "htmlUrl": "https://github.com/yourorg/yourrepo/blob/main/src/auth/login.js#L42" } ] } } ```