Quick Start

Get up and running with the API in just a few steps.

Visit the dashboard to create an account or sign in to your existing account.

Create an API Key

Navigate to the API Keys section in your dashboard
Click Create New API Key
Give your key a descriptive name
Copy and securely store your API key

⚠️ Important: Your API key will only be shown once. Store it securely.

Make Your First API Call

Extract text content from a document using the extract endpoint:

Extract document content

curl -X POST 'https://api.omnitext.io/v1/extract/markdown' \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@/path/to/your/document.pdf'

Extract document content

const formData = new FormData();
formData.append('file', fileInput.files[0]);

const response = await fetch('https://api.omnitext.io/v1/extract/markdown', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: formData
});

const data = await response.json();
console.log(data.content);

Extract document content

import requests

url = 'https://api.omnitext.io/v1/extract/markdown'
headers = {'x-api-key': 'YOUR_API_KEY'}
files = {'file': open('/path/to/your/document.pdf', 'rb')}

response = requests.post(url, headers=headers, files=files)
print(response.json())

The response will include the extracted content and metadata:

{
  "success": true,
  "metadata": {
    "title": "Document Title",
    "pages": 5,
    "wordCount": 1250,
    ...
  },
  "content": "# Document Title\n\nExtracted content..."
}

Next Steps

Authentication - Learn about API authentication methods
Rate Limits - Understand usage limits and billing

Quick Start

Quick Start

Register or Sign In

Create an API Key

Make Your First API Call

Next Steps

On this page