Project

Project configuration endpoint

Project configuration endpoint

Get project

Retrieve the active project configuration.

GET
/project

Query Parameters

project?string

Project override

Response Body

curl -X GET "https://loading/api/v0/project?project=string"
{
  "data": {
    "author": {
      "contributors": [
        {
          "email": "string",
          "name": "string",
          "organization": "string",
          "url": "string"
        }
      ],
      "email": "string",
      "name": "string",
      "organization": "string",
      "url": "string"
    },
    "autoload": {
      "property1": null,
      "property2": null
    },
    "config": {
      "property1": null,
      "property2": null
    },
    "description": "string",
    "memories": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "models": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "monitoring": {
      "property1": null,
      "property2": null
    },
    "name": "string",
    "runtime": {
      "property1": null,
      "property2": null
    },
    "schemas": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "tools": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "version": "string",
    "workflows": [
      {
        "property1": null,
        "property2": null
      }
    ]
  },
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "message": "string",
  "status": 0
}
{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Create or update project

Create the project configuration when absent or update an existing one using strong ETag concurrency.

PUT
/project

Query Parameters

project?string

Project override

Header Parameters

If-Match?string

Strong ETag for optimistic concurrency

Project configuration payload

Empty Object

Response Body

curl -X PUT "https://loading/api/v0/project?project=string" \
  -H "If-Match: string" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "data": {
    "author": {
      "contributors": [
        {
          "email": "string",
          "name": "string",
          "organization": "string",
          "url": "string"
        }
      ],
      "email": "string",
      "name": "string",
      "organization": "string",
      "url": "string"
    },
    "autoload": {
      "property1": null,
      "property2": null
    },
    "config": {
      "property1": null,
      "property2": null
    },
    "description": "string",
    "memories": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "models": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "monitoring": {
      "property1": null,
      "property2": null
    },
    "name": "string",
    "runtime": {
      "property1": null,
      "property2": null
    },
    "schemas": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "tools": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "version": "string",
    "workflows": [
      {
        "property1": null,
        "property2": null
      }
    ]
  },
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "message": "string",
  "status": 0
}
{
  "data": {
    "author": {
      "contributors": [
        {
          "email": "string",
          "name": "string",
          "organization": "string",
          "url": "string"
        }
      ],
      "email": "string",
      "name": "string",
      "organization": "string",
      "url": "string"
    },
    "autoload": {
      "property1": null,
      "property2": null
    },
    "config": {
      "property1": null,
      "property2": null
    },
    "description": "string",
    "memories": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "models": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "monitoring": {
      "property1": null,
      "property2": null
    },
    "name": "string",
    "runtime": {
      "property1": null,
      "property2": null
    },
    "schemas": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "tools": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "version": "string",
    "workflows": [
      {
        "property1": null,
        "property2": null
      }
    ]
  },
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "message": "string",
  "status": 0
}
{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Delete project

Project deletion is not supported; returns 405.

DELETE
/project

Response Body

curl -X DELETE "https://loading/api/v0/project"
{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}