/v2/{path} (OPTIONS)

OPTIONS

/v2/{path}

curl --request OPTIONS \
  --url https://infra-hyphae.run/v2/example \
  --header 'Authorization: Bearer <token>'

• The hosted deployment (CloudFront terminates TLS; cloudd behind it).
• Local cloudd (loopback), plain HTTP.

Authorizations

• projectKey

Parameters

Path Parameters

path

required

string

Remainder of the Native /v2 path, e.g. capabilities, sql, search.

Header Parameters

X-Hyphae-Project

string

/^(prj_)?[0-9a-f]{16}$/

Optional tenant reference (prj_<16 hex> or the bare hex) for clients that cannot set Host. Must match the key’s project.

Responses

401

Missing, malformed, duplicate, or unknown credential (authentication_required).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

Headers

WWW-Authenticate

string

Allowed value: Bearer realm="hyphae-cloud"

403

Valid credential for a different project than the one referenced, or an account signup without a valid invite code on an invite-gated deployment (authorization_denied).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

413

Body exceeds the surface’s limit (payload_too_large).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

502

The engine failed to start or did not answer (upstream_unavailable).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

503

The project has no running engine; call wakeup (tenant_not_running).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

2XX

Native’s answer, unchanged.

4XX

Native’s answer, unchanged (for example 400 for a missing X-Hyphae-Protocol-Minor).