Base URL
All API requests should be made to:Authentication
The Structify API uses Bearer token authentication. Include your API key in the Authorization header:Obtaining an API Key
- Log into the Structify Dashboard
- Navigate to Settings → API Keys
- Click “Create New Key”
- Copy the key immediately (it won’t be shown again)
Keep your API keys secure. Never commit them to version control or expose them in client-side code.
Request Format
Headers
All requests should include these headers:Request Body
POST and PUT requests should send JSON:Response Format
Success Response
Successful responses return HTTP 200-299 with JSON:Error Response
Errors return appropriate HTTP status codes with details:Status Codes
Code | Description |
---|---|
200 | Success - Request completed |
201 | Created - Resource created |
204 | No Content - Success with no response body |
400 | Bad Request - Invalid parameters |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource doesn’t exist |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal Error - Server error |
Rate Limiting
API requests are rate limited per API key:- Standard: 1000 requests per minute
- Pro: 5000 requests per minute
- Enterprise: Custom limits
Pagination
List endpoints support pagination via query parameters:WebSocket API
Real-time updates via WebSocket connection:Event Types
workflow.started
- Workflow execution beganworkflow.node.complete
- Node finished executingworkflow.completed
- Workflow finishedworkflow.failed
- Workflow encountered error
API Versioning
The API is versioned via the URL path:- Current:
/v1/
- Legacy:
/v0/
(deprecated)
We maintain backwards compatibility within major versions. Breaking changes require a new major version.
SDK Libraries
Official SDKs handle authentication and provide type safety:OpenAPI Specification
The complete API specification is available in OpenAPI 3.0 format: You can use this specification with tools like:- Postman: Import for testing
- Swagger Codegen: Generate client libraries
- OpenAPI Generator: Create SDKs