> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gostudio.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get job status

> Returns the current status and results of a generation job by its encoded ID. Works across all GoStudio tools — watermark remover, photo generation, photo recreation, group photo, age modifier, and others.

Use the `job_id` value returned by the generation endpoint that created the job — photo endpoints (`/api/v2/photo/*` and `/api/v2/image/group-photo`) return an encoded string `job_id` that is used here directly. Do not construct or guess this value.

`output_urls` is only present once `status` is `completed`. `error` is only present when `status` is `failed` or `abandoned`.

**Ownership:** `user` callers can only retrieve jobs they own. Other caller types may access any job.

Allowed callers: `user`, `internal`, `external`.




## OpenAPI

````yaml /openapi.yaml get /api/v2/apps/job/{job_id}
openapi: 3.0.3
info:
  title: GoStudio API
  version: 2.0.0
  description: >
    The GoStudio v2 REST API. Every response uses a standard envelope: successes
    return `{ status, data }`; errors return `{ status, error: { type, code,
    message } }`.


    All endpoints require a **Bearer token** in the `Authorization` header. The
    one exception is the provider webhook callback, which is authenticated by
    signature.
servers:
  - url: https://www.gostudio.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Watermark Remover
    description: AI watermark removal — orchestration, model metadata, and job polling.
  - name: Photo
    description: >-
      AI photo generation — generate, recreate, and manage trained profile
      photos.
  - name: Image
    description: Image utilities — group photo composition and image-to-prompt analysis.
  - name: Media
    description: Media upload and CDN management.
  - name: Apps
    description: GoStudio application tools — age modifier and other transformations.
  - name: Job Status
    description: Generic job polling — works across all GoStudio tools.
  - name: Webhooks
    description: Endpoints called by external services, not by your application.
paths:
  /api/v2/apps/job/{job_id}:
    get:
      tags:
        - Job Status
      summary: Get job status
      description: >
        Returns the current status and results of a generation job by its
        encoded ID. Works across all GoStudio tools — watermark remover, photo
        generation, photo recreation, group photo, age modifier, and others.


        Use the `job_id` value returned by the generation endpoint that created
        the job — photo endpoints (`/api/v2/photo/*` and
        `/api/v2/image/group-photo`) return an encoded string `job_id` that is
        used here directly. Do not construct or guess this value.


        `output_urls` is only present once `status` is `completed`. `error` is
        only present when `status` is `failed` or `abandoned`.


        **Ownership:** `user` callers can only retrieve jobs they own. Other
        caller types may access any job.


        Allowed callers: `user`, `internal`, `external`.
      operationId: getJobStatus
      parameters:
        - name: job_id
          in: path
          required: true
          description: UUID-encoded job identifier returned by the generation endpoint.
          schema:
            type: string
            example: 5a3f1e7d-9b4c-1a51-0b36-c893429659b5
      responses:
        '200':
          description: Job status returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                  data:
                    $ref: '#/components/schemas/JobStatusResult'
        '400':
          description: The job_id is not a valid encoded job identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 400
                error:
                  type: validation_error
                  code: invalid_input
                  dev: 40001
                  message: jobId is not a valid encoded job identifier.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Job not found, or not owned by the authenticated user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 404
                error:
                  type: not_found_error
                  code: job_not_found
                  dev: 40404
                  message: Job not found.
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    JobStatusResult:
      type: object
      properties:
        job_id:
          type: string
          description: UUID-encoded job identifier.
          example: 5a3f1e7d-9b4c-1a51-0b36-c893429659b5
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - abandoned
          description: >
            Current state of the job. `output_urls` is populated only when
            `completed`; `error` is populated only when `failed` or `abandoned`.
        tool_name:
          type: string
          description: The GoStudio tool that created this job.
          example: watermark_remover
        output_urls:
          type: array
          description: >-
            CDN URLs for the finished images. Present only when `status` is
            `completed`.
          items:
            type: string
            format: uri
        error:
          type: string
          description: >-
            Sanitized failure reason. Present only when `status` is `failed` or
            `abandoned`.
        created_at:
          type: string
          format: date-time
          description: When the job was created.
        updated_at:
          type: string
          format: date-time
          description: When the job was last updated.
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          example: 400
        error:
          type: object
          properties:
            type:
              type: string
              example: validation_error
            code:
              type: string
              example: invalid_input
            dev:
              type: integer
              example: 40001
            message:
              type: string
              example: Some information is invalid.
  responses:
    Unauthorized:
      description: Missing or invalid Authorization Bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 401
            error:
              type: authentication_error
              code: unauthorized
              dev: 40100
              message: Missing or invalid Authorization Bearer token.
    Forbidden:
      description: Caller type not allowed for this endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 403
            error:
              type: permission_error
              code: forbidden
              dev: 40300
              message: You don't have permission for this action.
    RateLimited:
      description: Too many requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 429
            error:
              type: rate_limit_error
              code: rate_limited
              dev: 42900
              message: You're doing that too often. Please wait a moment.
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 500
            error:
              type: system_error
              code: internal_error
              dev: 50000
              message: Something went wrong on our end.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Supabase user JWT (or an internal service token). Send as
        `Authorization: Bearer <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.