Skip to content
Aura

List Projects

GET
/api/v1/projects
curl --request GET \
  --url 'https://aura.strangeworks.com/api/v1/projects?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit

Maximum rows to return.

integer
default: 50 >= 1 <= 200

Maximum rows to return.

offset
Offset

Rows to skip before the returned page.

integer
0

Rows to skip before the returned page.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ProjectSummaryListResponse
object
limit
required
Limit
integer
offset
required
Offset
integer
projects
required
Projects
Array<object>
ProjectSummary
object
card_count
Card Count
integer
0
completeness
CompletenessResponse

Mirrors the fixed shape returned by completeness_service.compute_completeness().

object
all_constraints_classified
All Constraints Classified
boolean
all_variables_provided
All Variables Provided
boolean
data_available
Data Available
boolean
feasibility_result
Feasibility Result
string
default: unchecked
Allowed values: pass fail unchecked
kpis_defined
Kpis Defined
boolean
objective_drafted
Objective Drafted
boolean
objectives_defined
Objectives Defined
boolean
overall
Overall
string
default: incomplete
Allowed values: incomplete complete
production_requirements_defined
Production Requirements Defined
boolean
created_at
required
Created At
string format: date-time
created_by
Any of:
ProjectCreator
object
avatar_url
Any of:
string
display_name
required
Display Name
string
id
required
Id
string
description
required
Any of:
string
id
required
Id
string
name
required
Name
string
objective_components
Objective Components
Array<object>
default:
object
key
additional properties
objective_confirmed
Objective Confirmed
boolean
objective_description
Any of:
string
objective_type
Any of:
string
run_setup_status
Any of:
string
short_description
required
Any of:
string
status
Status
string
default: empty
Allowed values: empty defining definition_ready modeling modeling_failed in_run model_to_run_failed
total_cost_usd
Total Cost Usd
number
0
updated_at
required
Updated At
string format: date-time
workspace_mode
Workspace Mode
string
default: define
Allowed values: define run
total
required
Total
integer
Example
{
  "projects": [
    {
      "card_count": 0,
      "completeness": {
        "all_constraints_classified": false,
        "all_variables_provided": false,
        "data_available": false,
        "feasibility_result": "unchecked",
        "kpis_defined": false,
        "objective_drafted": false,
        "objectives_defined": false,
        "overall": "incomplete",
        "production_requirements_defined": false
      },
      "objective_components": [],
      "objective_confirmed": false,
      "status": "empty",
      "total_cost_usd": 0,
      "workspace_mode": "define"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}