Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsCreate Organization Logo Grant
Search the full API reference Esc to close

Create Organization Logo Grant

Organization · REST API reference

Get support
POST/v1/organization/logo
Step 1 of the org-logo asset upload handshake. ``kind="org_logo"`` is hardcoded here -- never client-supplied (media-upload spec task 5.5).

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/organization/logo' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "declared_size_bytes": 0,
  "mime_type": "string",
  "sha256": "<VALUE_MATCHING_PATTERN>"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Request body

application/json · Required

declared_size_bytesintegerrequired
mime_typestringrequired
sha256stringrequired

64-character hex SHA-256 of the file content

Pattern: ^[0-9a-fA-F]{64}$

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

201Successful Response
JSON · generated example
{
  "data": {
    "already_uploaded": false,
    "asset_id": "00000000-0000-4000-8000-000000000001",
    "expires_at": "2026-10-29T12:00:00Z",
    "fields": {},
    "upload_url": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataAssetUploadGrantResponserequired

Step-1 response. ``already_uploaded=True`` means the content-address dedup (section 8.3) found existing, already-confirmed bytes for this ``(org, sha256)`` -- the consumer FK is already repointed, ``upload_url``/ ``fields`` are empty, and the caller should skip step 2 (the S3 POST) and step 3 (``/complete``) entirely.

Show data schema
already_uploadedbooleanrequired
asset_idstringrequired

Format: uuid

expires_atstringrequired

Format: date-time

fieldsobjectrequired
upload_urlstringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Create Organization Logo Grant | Facily Developers