For the complete documentation index, see llms.txt. This page is also available as Markdown.

Choose an API response format

Choose JSON, XML, Text, or Blob to match an endpoint response.

Match the response format to the data returned by the endpoint.

Format
Use for

JSON

Objects and arrays, such as customer records

XML

Structured XML responses

Text

Plain text, logs, or messages

Blob

Binary responses, such as files

Configure and check the response

  1. Test the endpoint and inspect its returned content.

  2. Choose the response format matching that content.

  3. Preview the result and confirm that the expected values are available.

  4. For a JSON list nested inside an object, select its root and map the fields using Transform API responses.

API Builder response format options

A response format controls how content is handled. It does not rename fields or select a nested list; those are transformation tasks.

Last updated

Was this helpful?