Restore an earlier version

curl --request POST \
  --url https://guidinghand.ai/v1/agents/{agent_id}/file_revisions/{revision_id}/restore \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://guidinghand.ai/v1/agents/{agent_id}/file_revisions/{revision_id}/restore', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://guidinghand.ai/v1/agents/{agent_id}/file_revisions/{revision_id}/restore"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "object": "agent_file",
  "agent_id": "billing",
  "path": "/notes/customers.md",
  "bytes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": {
    "type": "user",
    "email": "jane@acme.com"
  },
  "content": "<string>",
  "kind": "text",
  "content_type": "text/markdown"
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

POST

agents

{agent_id}

file_revisions

{revision_id}

restore

Restore an earlier version

curl --request POST \
  --url https://guidinghand.ai/v1/agents/{agent_id}/file_revisions/{revision_id}/restore \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://guidinghand.ai/v1/agents/{agent_id}/file_revisions/{revision_id}/restore', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://guidinghand.ai/v1/agents/{agent_id}/file_revisions/{revision_id}/restore"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "object": "agent_file",
  "agent_id": "billing",
  "path": "/notes/customers.md",
  "bytes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": {
    "type": "user",
    "email": "jane@acme.com"
  },
  "content": "<string>",
  "kind": "text",
  "content_type": "text/markdown"
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "code": "<string>",
    "test_case_ids": [
      "<string>"
    ],
    "decided_by": {
      "type": "person",
      "email": "<string>",
      "key_id": "<string>"
    },
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "approval_id": "<string>",
    "question_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

agent_id

string

required

The agent’s id, e.g. billing.

revision_id

string

required

Response

object

any

agent_id

string

Example:

"billing"

path

string

Always starts with /.

Example:

"/notes/customers.md"

bytes

integer

Its size: a text file’s in UTF-8, any other file’s as it was saved.

created_at

string<date-time>

updated_at

string<date-time>

updated_by

Person · object

Who wrote the file: a person, an API key, or the agent itself (task_id; with procedure and conversation_id when a procedure let it).

Person
API key
Agent

Show child attributes

content

string | null

Only when you get or write one file. A text file’s text; an Excel, Word or PowerPoint file’s text as the agent reads it (a spreadsheet as CSV, sheet by sheet); null for a PDF or an image. GET with ?download=1 for the file itself.

kind

enum<string>

text: any text file (notes, CSV, JSON, Markdown…). spreadsheet, document, slides: an Excel, Word or PowerPoint file (.xlsx, .docx, .pptx), read as text. pdf and image: the model sees them in a chat.

Available options:

text,

spreadsheet,

document,

slides,

pdf,

image

content_type

string

Example:

"text/markdown"