Outerport

Documentation

Blog

API Reference

Support

English

日本語

API Reference Introduction

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.

Generate component from image

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.

Upload and process a document

Retrieves a list of all visible documents in the system.

Get all documents

Retrieves a signed upload URL for a document.

Get a signed upload URL for a document

Trigger processing of a document after client has uploaded to storage.

Update document file content

Retrieves a list of all tags from documents the user has access to.

Get all tags

Retrieves a document by its unique identifier.

Get a document by ID

Deletes a document by its unique identifier.

Delete a document

Updates a document's properties by its unique identifier.

Update a document

Retrieves all visual components associated with a document.

Get document visual components

Retrieves all text blocks associated with a document.

Get document text blocks

Retrieves a list of users who have access to the document.

Get document collaborators

Add collaborators to a document

Associates a tag with a document. Creates the tag if it doesn't exist.

Add a tag to a document

Retrieves a list of tags associated with a document.

Get tags for a document

Removes the association between a tag and a document.

Remove a tag from a document

Searches for documents based on the provided query and optional filters.

Search for documents

Retrieves a document search by its unique identifier.

Get a document search by ID

Associates a retention policy with a document. Multiple retention policies can be associated with a single document.

Add a retention policy to a document

Retrieves all retention policies associated with a document.

Get retention policies for a document

Removes the retention policy association from a document.

Remove a retention policy from a document

Get Job Status

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.

Ask a question

Retrieves a question & answer by its unique identifier.

Get a question & answer by ID

Deletes a question and its associated data by its unique identifier.

Delete a question

Retrieves a question & answer by its unique identifier and streams the updates to the client using Server-Sent Events (SSE).

Get a question & answer by ID (streamed)

Returns a list of all threads belonging to the authenticated user.

List threads

Creates a new thread with the given name.

Create a thread

Associates a question with a thread at the specified position.

Add a question to a thread

Returns a specific thread by ID with its full list of questions if it belongs to the authenticated user.

Get a thread by ID

Update a thread

Deletes a thread and all its question associations.

Delete a thread

Creates or updates a question at the specified position in the thread.

Upsert a question at a specific position

Removes the question at the specified position and reorders remaining questions.

API Reference

Components

Documents

Job Status

Questions & Answers

Threads

Update settings