Skip to main content
ArgumentDescriptionValueNotes
Base URL / DomainThe base URL or domain for the Swarms APIhttps://api.swarms.worldProduction URL for all API requests
Headers: x-api-keyAPI key header for authenticationx-api-key: <your-api-key>Required for authenticating requests
Headers: Content-TypeSpecifies the media type of the request bodyapplication/jsonIndicates JSON payload for POST/PUT requests
Headers: Accept-EncodingCompression formats supported by the clientgzip, lz4Client indicates it can handle gzip or lz4 compressed responses
MethodHTTP methods supportedGET, POST, PUT, DELETE, etc.Typical REST API methods; specific methods depend on endpoint
Request BodyJSON payload for requests (for POST/PUT){"key": "value"}Must conform to application/json content type
Response FormatExpected response formatapplication/jsonAPI returns JSON responses
CompressionCompression algorithms supported for responsegzip, lz4Server may compress responses if client supports it (via Accept-Encoding)

Notes:

  • Base URL: Use https://api.swarms.world for all API requests.
  • API Key: Replace <your-api-key> with the actual key provided by the Swarms API service.
  • Compression: gzip and lz4 are supported for response compression via the Accept-Encoding header.