Skip to main content
ArgumentDescriptionPrimary ValueOptional ValueNotes
Base URL / DomainThe base URL or domain for the Swarms APIhttps://swarms-api-285321057562.us-east1.run.appapi.swarms.worldPrimary is production URL/domain; optional is also functional
Headers: x-api-keyAPI key header for authenticationx-api-key: <your-api-key>N/ARequired for authenticating requests
Headers: Content-TypeSpecifies the media type of the request bodyapplication/jsonN/AIndicates JSON payload for POST/PUT requests
Headers: Accept-EncodingCompression formats supported by the clientgzip, lz4N/AClient indicates it can handle gzip or lz4 compressed responses
MethodHTTP methods supported (inferred)GET, POST, PUT, DELETE, etc.N/ATypical REST API methods; specific methods depend on endpoint
Request BodyJSON payload for requests (for POST/PUT){"key": "value"}N/AMust conform to application/json content type
Response FormatExpected response format (inferred)application/jsonN/AAPI returns JSON responses
CompressionCompression algorithms supported for responsegzip, lz4N/AServer may compress responses if client supports it (via Accept-Encoding)

​
Notes:

  • Base URL / Domain: Combined into one argument. The primary value is either https://swarms-api-285321057562.us-east1.run.app or api.swarms.world (both are valid for production, with the domain likely resolving to the URL)
  • Other Arguments: Remain unchanged as they don’t involve URLs or domains. No additional URLs were provided, so only the Base URL / Domain has primary and optional values.
  • 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.