Pipeline status

GET https://api.visualpdf.com/v1/pipeline/{id}

Retrieves the status of a pipeline from its id.

Path parameters

Name	Description	Type	Required
id	The id of the pipeline.	String	Yes

Example

Request (NodeJS)

    
      // Getting the status of a pipeline
      const pipelineStatusResponse = await fetch(
        'https://api.visualpdf.com/v1/pipeline/6ecd8c99-4036-403d-bf84-cf8400f67836',
        {
          method: 'GET',
          headers: { Authorization: `Bearer ${my_API_key}` },
        },
      );

Responses

    
      {
        pipelineid: '6ecd8c99-4036-403d-bf84-cf8400f67836',
        'webhook-url': 'https://your-domain.com/visual-pdf-webhook',
        status: 'running',
        started: '2024-05-29T16:08:43.511Z',
      }

    
      {
        pipelineid: '6ecd8c99-4036-403d-bf84-cf8400f67836',
        duration: 823,
        files: [
          {
            name: 'compress_1',
            id: '40e6215d-b5c6-4896-987c-f30f3678f608',
            link: 'https://api.visualpdf.com/v1/download/40e6215d-b5c6-4896-987c-f30f3678f608',
          },
        ],
        status: 'succeeded',
        started: '2024-05-29T16:08:43.511Z',
      }

Errors

HTTP code	Description
400 - Bad Request	The request was unacceptable, often due to missing or invalid pipeline id.
401 - Unauthorized	No valid API key provided.
404 - Not found	The requested pipeline doesn't exist.
429 - Too Many Requests	Too many requests hit the API too quickly.
5xx - Server Errors	Something went wrong on our end.

Download

Quota