# Outerport

## Docs

- [Generate component from image](https://docs.outerport.com/api-reference/components/generate-component-from-image.md): Analyzes an uploaded image and generates flowchart components based on the visual content. Currently supports 'flowchart' type (generates Mermaid syntax). Other types will return 501 Not Implemented.
- [Add a retention policy to a document](https://docs.outerport.com/api-reference/documents/add-a-retention-policy-to-a-document.md): Associates a retention policy with a document. Multiple retention policies can be associated with a single document.
- [Add a tag to a document](https://docs.outerport.com/api-reference/documents/add-a-tag-to-a-document.md): Associates a tag with a document. Creates the tag if it doesn't exist.
- [Add collaborators to a document](https://docs.outerport.com/api-reference/documents/add-collaborators-to-a-document.md): Adds collaborators to a document.
- [Delete a document](https://docs.outerport.com/api-reference/documents/delete-a-document.md): Deletes a document by its unique identifier.
- [Get a document by ID](https://docs.outerport.com/api-reference/documents/get-a-document-by-id.md): Retrieves a document by its unique identifier.
- [Get a document search by ID](https://docs.outerport.com/api-reference/documents/get-a-document-search-by-id.md): Retrieves a document search by its unique identifier.
- [Get a signed upload URL for a document](https://docs.outerport.com/api-reference/documents/get-a-signed-upload-url-for-a-document.md): Retrieves a signed upload URL for a document.
- [Get all documents](https://docs.outerport.com/api-reference/documents/get-all-documents.md): Retrieves a list of all visible documents in the system.
- [Get all tags](https://docs.outerport.com/api-reference/documents/get-all-tags.md): Retrieves a list of all tags from documents the user has access to.
- [Get document collaborators](https://docs.outerport.com/api-reference/documents/get-document-collaborators.md): Retrieves a list of users who have access to the document.
- [Get document text blocks](https://docs.outerport.com/api-reference/documents/get-document-text-blocks.md): Retrieves all text blocks associated with a document.
- [Get document visual components](https://docs.outerport.com/api-reference/documents/get-document-visual-components.md): Retrieves all visual components associated with a document.
- [Get retention policies for a document](https://docs.outerport.com/api-reference/documents/get-retention-policies-for-a-document.md): Retrieves all retention policies associated with a document.
- [Get tags for a document](https://docs.outerport.com/api-reference/documents/get-tags-for-a-document.md): Retrieves a list of tags associated with a document.
- [Remove a retention policy from a document](https://docs.outerport.com/api-reference/documents/remove-a-retention-policy-from-a-document.md): Removes the retention policy association from a document.
- [Remove a tag from a document](https://docs.outerport.com/api-reference/documents/remove-a-tag-from-a-document.md): Removes the association between a tag and a document.
- [Search for documents](https://docs.outerport.com/api-reference/documents/search-for-documents.md): Searches for documents based on the provided query and optional filters.
- [Update a document](https://docs.outerport.com/api-reference/documents/update-a-document.md): Updates a document's properties by its unique identifier.
- [Update document file content](https://docs.outerport.com/api-reference/documents/update-document-file-content.md): Trigger processing of a document after client has uploaded to storage.
- [Upload and process a document](https://docs.outerport.com/api-reference/documents/upload-and-process-a-document.md): Creates a document from either a file upload or URL. For file uploads, use multipart/form-data. For URLs, use application/json with a URL field.
- [API Reference Introduction](https://docs.outerport.com/api-reference/introduction.md): Complete guide to the Outerport API
- [Get Job Status](https://docs.outerport.com/api-reference/job-status/get-job-status.md): Get Job Status
- [Ask a question](https://docs.outerport.com/api-reference/questions/ask-a-question.md): Asks a question (in reference to a document), returning a question ID and a job status ID to track the completion state. Maximum questions per user is 100.
- [Delete a question](https://docs.outerport.com/api-reference/questions/delete-a-question.md): Deletes a question and its associated data by its unique identifier.
- [Get a question & answer by ID](https://docs.outerport.com/api-reference/questions/get-a-question-and-answer-by-id.md): Retrieves a question & answer by its unique identifier.
- [Get a question & answer by ID (streamed)](https://docs.outerport.com/api-reference/questions/get-a-question-and-answer-by-id-streamed.md): Retrieves a question & answer by its unique identifier and streams the updates to the client using Server-Sent Events (SSE).
- [Add a question to a thread](https://docs.outerport.com/api-reference/threads/add-a-question-to-a-thread.md): Associates a question with a thread at the specified position.
- [Create a thread](https://docs.outerport.com/api-reference/threads/create-a-thread.md): Creates a new thread with the given name.
- [Delete a thread](https://docs.outerport.com/api-reference/threads/delete-a-thread.md): Deletes a thread and all its question associations.
- [Get a thread by ID](https://docs.outerport.com/api-reference/threads/get-a-thread-by-id.md): Returns a specific thread by ID with its full list of questions if it belongs to the authenticated user.
- [List threads](https://docs.outerport.com/api-reference/threads/list-threads.md): Returns a list of all threads belonging to the authenticated user.
- [Remove a question at a specific position](https://docs.outerport.com/api-reference/threads/remove-a-question-at-a-specific-position.md): Removes the question at the specified position and reorders remaining questions.
- [Update a thread](https://docs.outerport.com/api-reference/threads/update-a-thread.md): Updates a thread's name.
- [Upsert a question at a specific position](https://docs.outerport.com/api-reference/threads/upsert-a-question-at-a-specific-position.md): Creates or updates a question at the specified position in the thread.
- [Overview](https://docs.outerport.com/en/overview.md)
- [Quickstart](https://docs.outerport.com/en/quickstart.md)

## OpenAPI Specs

- [openapi](https://docs.outerport.com/api-reference/openapi.json)

## Optional

- [Documentation](https://docs.outerport.com)
- [Blog](https://outerport.com/blog)