GET /projects/{projectId}/jobs/{jobId}/status
Oauth2

Get status of project job by ID

Path parameters

  • projectId string Required

    Project ID

  • jobId string Required

    Job ID

Responses

  • 202 application/json

    Accepted

    Hide response attribute Show response attribute object
    • state string

      Current job state

      Values are pending, started, success, failure, or canceled.
  • 201 application/json

    Created

    Hide response attributes Show response attributes object
    • id string Required
    • name string | null Required
    • type string Required

      Type name

    • state string Required

      Current job state

      Values are pending, started, success, failure, or canceled.

    • created string Required

      ISO 8601 datetime

    • started string Required

      ISO 8601 datetime

    • finished string Required

      ISO 8601 datetime

    • error string | null Required

      Error message for failed jobs

    • inputs object Required

      Job assets and parameters

      Hide inputs attributes Show inputs attributes object
      • assets object | null

        Asset mapping

      • params object | null Required

        Parameter mapping

    • outputs object Required

      Job assets and parameters

      Hide outputs attributes Show outputs attributes object
      • assets object | null

        Asset mapping

      • params object | null Required

        Parameter mapping

    • needs array[string] Required

      IDs of upstream dependencies

    • project_id string Required

      Project ID

    • workflow_id string | null Required

      Workflow ID, if part of a workflow
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • code integer

      HTTP response code

    • name string

      Status text corresponding to the HTTP response code

    • description string

      Detailed error message
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • code integer

      HTTP response code

    • name string

      Status text corresponding to the HTTP response code

    • description string

      Detailed error message
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • code integer

      HTTP response code

    • name string

      Status text corresponding to the HTTP response code

    • description string

      Detailed error message
GET /projects/{projectId}/jobs/{jobId}/status 
curl \
 --request GET 'https://api.metafold3d.com/projects/{projectId}/jobs/{jobId}/status' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (202) 
{
  "state": "pending"
}
Response examples (201) 
{
  "id": "123",
  "name": "sample-mesh",
  "type": "implicit/from-mesh",
  "needs": [
    "1",
    "2"
  ],
  "state": "success",
  "inputs": {
    "assets": {
      "mesh": {
        "id": "1",
        "size": 262144,
        "created": "2006-01-02T22:04:05+00:00",
        "checksum": "sha256:2d063a84b13e5b23730a509cbb6ba42534acde451249a0b7409172a4f8814ef0",
        "filename": "part.stl",
        "modified": "2006-01-02T22:04:05+00:00"
      }
    },
    "params": {
      "resolution": "256"
    }
  },
  "created": "2006-01-02T22:04:05+00:00",
  "outputs": {
    "assets": {
      "volume": {
        "id": "2",
        "size": 262144,
        "created": "2006-01-02T22:04:05+00:00",
        "checksum": "sha256:d8a0c9a50db61d021c311ef1a57e4531a75f30a3bea44d1db20d82d12d1bb2df",
        "filename": "18ac5faec0625a35.bin",
        "modified": "2006-01-02T22:04:05+00:00"
      }
    },
    "params": {
      "patch": "{\"size\": [2.0, 2.0, 2.0], \"offset\": [-1.0, -1.0, -1.0], \"resolution\": [256, 256, 256]}\n",
      "bounds": "{\"min\": [-1.0, -1.0, -1.0], \"max\": [1.0, 1.0, 1.0]}\n",
      "face_count": "1000",
      "vertex_count": "3000"
    }
  },
  "started": "2006-01-02T22:04:10+00:00",
  "finished": "2006-01-02T22:04:40+00:00",
  "project_id": "123",
  "workflow_id": "123"
}
Response examples (400) 
{
  "code": 400,
  "name": "Bad Request",
  "description": "Expected parameter \"foo\""
}
Response examples (401) 
{
  "code": 401,
  "name": "Unauthorzed",
  "description": "Token has expired"
}
Response examples (404) 
{
  "code": 404,
  "name": "Not Found",
  "description": "Resource does not exist"
}