Get a job

The status and, when it finished, the result of a live site search.

GEThttps://api.typesearch.ai/v1/jobs/{id}

Returns a job created by POST /v1/search/site. Poll it every couple of seconds until status is succeeded or failed — or let the SDK do it with jobs.wait().

Jobs last one day and are visible only to the key that created them; after that, or with another key, this returns 404 job_not_found.

Path

ParameterType
idstringThe job id, from the 202 response or its Location header.

Response

When the job succeeded, result is a search response with the same fields as POST /v1/search.

  • idstring

    The job id. Jobs last one day and are visible only to the key that created them.

  • object"job"

    Always job.

  • statusenum<string>

    queued, running, succeeded or failed.

  • created_atstring

    When it was created.

  • finished_atstring | null

    When it finished.

  • resultobject | null

    When succeeded: the search response, same shape as POST /v1/search.

    Same fields as the POST /v1/search response.

  • errorobject | null

    When failed: the problem details.

    Show child attributes
    • typestring

      urn:typesearch:error:<code>.

    • titlestring

      A short summary of the status.

    • statusinteger

      The HTTP status.

      Range: -9007199254740991–9007199254740991

    • detailstring

      What went wrong, for people.

    • codestring

      A stable error code, for programs.

    • request_idstring

      Include it when you contact support.

    • errorsobject[]

      Field-level validation errors, when the request was invalid.

      Show child attributes
      • pathstring

        The field, e.g. query.

      • messagestring

        What is wrong with it.