Understanding Your First Response

After sending a request to the Davix H2I API, the platform returns a response containing the result of the processing operation.

This response is what your application, workflow, or connected system uses to continue the next step. Depending on the endpoint and action, the result may be returned as a signed output URL or as structured JSON data.

For the HTML-rendering quickstart on POST /v1/h2i, a successful response returns a signed output URL and may also include a request_id.

What Happens After a Request #

When a request is sent:

  1. the API key is validated
  2. the request is checked and routed
  3. the H2I engine (PixLab) executes the operation
  4. the result is produced
  5. a response is returned to the client.

For file-producing operations, Davix H2I writes the result into the corresponding public output path and returns a signed URL. For some other operations, the result is returned as structured JSON instead.

Example Response #

For a successful /v1/h2i request, the public API reference defines the response as:

{
  "url": "https://pixlab.davix.dev/h2i/example-output.png?exp=EXPIRES_AT&sig=SIGNATURE",
  "request_id": "REQUEST_ID"
}

The external API reference documents the /v1/h2i success output as:

  • 200: { url, request_id? }

Response Fields #

url #

For file-producing operations, url is the signed URL of the generated output file.

For /v1/h2i, the output URL is built under the /h2i/<file> path.

For other file-producing endpoints, outputs are served through the corresponding public output paths such as /image/* and /pdf/*.

Because output URLs can be signed and time-limited, your application should treat them as generated access URLs rather than permanent public file links.

request_id #

request_id is the identifier attached to the request.

It is useful for:

  • debugging
  • tracing requests
  • support and logs.

How to Use the Response #

After receiving a successful file-producing response, your application usually uses the url field to continue its workflow.

Common patterns include:

  • downloading the generated file
  • displaying it in a user interface
  • passing it to another internal system
  • attaching it to a downstream process
  • storing a reference to it in your own system

For responses that return structured JSON instead of a file URL, your application uses the returned data directly.

Example Workflow #

A typical response-driven workflow looks like this:

  1. your application sends a request
  2. Davix H2I processes the request
  3. the response is returned
  4. your system uses the returned result in the next step

For a file-producing request, that next step may involve downloading the file, attaching it to an email, or passing the URL into another service. For structured-data responses, the next step may involve reading the returned JSON fields and acting on them programmatically.

Response Behavior by Endpoint #

Different endpoint groups can return different response shapes depending on the operation.

/v1/h2i #

Successful HTML-rendering requests return a signed output URL and may include request_id.

/v1/image #

File-producing image actions return signed output URLs, while the metadata-only path returns JSON instead of a hosted file output.

/v1/pdf #

Successful PDF operations return signed URL values for generated or modified PDF outputs.

/v1/tools #

Tools-related operations are analysis-oriented and should be treated as structured result flows rather than assumed file-download responses.

Handling Errors #

If a request fails, the API returns an error response instead of a success result.

Common error categories include:

  • invalid API key
  • missing required fields
  • invalid parameters
  • unsupported input
  • exceeded limits or quotas
  • processing failures or timeouts.

Detailed error behavior belongs in the Errors and Limits section.

Important Notes #

  • Do not assume every successful response has the same shape.
  • File-producing operations return signed output URLs.
  • Some operations return structured JSON instead.
  • Output URLs may be time-limited depending on platform configuration.

Summary #

When you send a request to Davix H2I, the H2I engine (PixLab) performs the underlying processing operation and Davix H2I returns the result through the API response.

For file-producing operations, the response includes a signed output URL that your application can use in the next step of its workflow. For other operations, the response may contain structured JSON data instead.

This is the corrected public version I would use.

Was it helpful ?
Table of contents
Login
Login
Login
Login
Scroll to Top