FousDocs

Read a build, waiting for it to finish

Read build progress, active time and the finished tool, with optional long polling.

GET/v1/builds/{build_id}

The build with its events and, once ready, its tool’s method and a verified example input. wait holds the answer up to that many seconds (170 at most) for the build to finish, so one call at a time follows it. Needs tools:read.

Requires Authorization: Bearer $FOUS_API_KEY. Create a key.

Path parameters

  • build_idstringrequired

Query parameters

  • waitintegerdefault 0

    Seconds to wait for the build to finish before answering.

Response 200

Success

  • successtruerequired
  • dataBuildrequired

    A build: from queued through exploring, compiling, verifying and publishing to ready, failed or cancelled. Once ready, api names the tool and method its operation; prepared_request carries an input the builder verified it with.

Errors

Every failure is an Error: branch on error.code. The errors guide lists each code.

  • 400
  • 401WWW-Authenticate
  • 402
  • 403
  • 404
  • 408
  • 409
  • 410
  • 413
  • 422
  • 429Retry-After
  • 500
  • 502
  • 503Retry-After
  • 504