External API Overview
The External API uses project API keys for authentication, making it suitable for external systems (scripts, CI/CD, third-party services).
Base URL
http://your-server:8000/external/v1Authentication
Pass the API key in every request's Authorization header:
Authorization: Bearer tf_b1af5033_3a7f2e1d9c...Create API keys at Project Settings → API Keys. The full key is shown only once — store it securely.
Format: tf_{first-8-hex-of-project-id}_{32-char-secret}
Error responses
json
{ "error": "invalid_api_key", "message": "API key is invalid or expired" }| Status | Meaning |
|---|---|
400 | Bad request or business logic error |
401 | Invalid or expired API key |
403 | API key does not belong to this project |
404 | Resource not found |