Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.octen.ai/llms.txt

Use this file to discover all available pages before exploring further.

API Errors

CodeMessageCauseSolution
400Bad RequestMissing required parameter or invalid request formatVerify all required parameters are included and properly formatted
401UnauthorizedInvalid or missing API keyEnsure your API key is correct and included in request headers
403ForbiddenInsufficient account balanceCheck your account balance and add credits if needed
413Request Entity Too LargeRequest payload exceeds the allowed size limitReduce payload size (e.g., shorten input or split into smaller requests)
429Too Many RequestsRequest rate limit exceededImplement exponential backoff and reduce request rate
500Internal Server ErrorUnexpected server-side error occurredRetry your request after a brief delay. Contact support if issue persists

Error Response Structure

All error responses follow a consistent structure:
{
  "code": 400,
  "msg": "Missing parameter query",
  "data": {},
  "meta": {}
}

Response Fields

FieldTypeDescription
codeintegerHTTP status code indicating the error type
msgstringHuman-readable message describing the error
dataobjectAdditional error details (typically empty for errors)
metaobjectMetadata about the error (typically empty for errors)

Extract: Partial Failures

A request to Extract may return 200 OK overall while individual URLs within the request fail; failed URLs are marked with status: "failed" and include an error_message. Failed URLs are not billed. This per-URL success/failure model is currently unique to the Extract API. Example response with partial failures:
{
  "code": 0,
  "msg": "success",
  "data": {
    "results": [
      { "url": "https://example.com/ok", "status": "success" },
      {
        "url": "https://example.com/missing",
        "status": "failed",
        "error_message": "Target returned HTTP 404"
      }
    ]
  },
  "meta": {
    "usage": { "total_urls": 2, "successful_urls": 1 }
  }
}
Common error_message values returned by Extract:
Scenariomessage
Invalid URL formatInvalid URL format
DNS resolution failedFailed to resolve domain
Target host unreachableTarget host unreachable
Target returned 4xxTarget returned HTTP {code}
Target returned 5xxTarget server error (HTTP {code})
Anti-bot protection blocked the requestBlocked by target anti-bot protection
Target rate-limited the requestTarget rate limited (HTTP 429)
Extraction timeout exceededExtraction timed out after {timeout}s
JavaScript rendering failedPage requires JavaScript rendering but failed
Unsupported content typeContent type not supported: {content_type}
HTML parsing failedFailed to parse page content

Getting Help

If you encounter persistent errors or need clarification:
  • API Reference: Check our API Documentation for parameter requirements
  • Rate Limits: Review the Rate Limits page for your plan
  • Status Page: Visit status for real-time system status
  • Contact Support: Email support@octen.ai with your request_id