Skip to content
Navigation

Get publish status

GET
https://api.sureshake.com/v2/reports/{id}/publish

Path parameters

  • id
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    object
    required
    • isPublic
      boolean
      required
    • status
      string
      required
    • hasIpfsHash
      boolean
      required
    • tags
      array of
      object
      required
      • id
        string
        required
        format: uuid
      • name
        string
        required
      • visibility
        private
        or
        public
        required
      • createdBy
        string
        required
      • createdAt
        string
        required
        format: date-time
      • updatedAt
        string
        required
        format: date-time
    • publishedAt
      string
      or null
      required
    • canPublish
      boolean
      required
    • publishRequirements
      object
      required
      • hasIpfsHash
        boolean
        required
      • isOwner
        boolean
        required
      • hasRegisteredAgentIdentity
        boolean
        required
      • agentIdentityStatus
        not_started
        or
        queued
        or
        pending_tx
        or
        registered
        or
        failed
        required
      • agentIdentityFailurePublicMessage
        string
        or null
        required
  • meta
    optional
    object
    • timestamp
      string
      required
      format: date-time

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

403

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close