​
Overview

The Outerport API is a RESTful API that enables document processing, AI-powered question answering, and advanced document management capabilities. All endpoints return JSON responses and use standard HTTP status codes.

OpenAPI Specification

View the complete OpenAPI specification file

​
Base URL

All API requests should be made to: 
https://api.outerport.com

​
Authentication

All API endpoints require authentication using Bearer tokens. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Contact your administrator to obtain an API key.

​
Rate Limits

API requests are subject to rate limiting. Check response headers for current limits:
  • X-RateLimit-Limit: Maximum requests per time window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets

​
API Structure

The Outerport API is organized into the following main resource groups:

Documents

Upload, manage, and process documents with OCR and layout detection

Questions

Ask AI-powered questions about document content and get contextual answers

Job Status

Monitor the status of asynchronous operations like document processing

Threads

Organize conversations and maintain context across multiple questions

​
Response Format

All API responses follow a consistent JSON format: 
{
  "id": 123,
  "status": "success",
  "data": { },
  "created_at": "2023-12-01T10:00:00Z"
}

​
Error Handling

The API uses standard HTTP status codes and returns detailed error messages: 
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid parameters",
    "details": {
      "field": "document_id",
      "issue": "Document not found"
    }
  }
}
Common status codes:
  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 422 - Validation Error
  • 500 - Internal Server Error