# Resources

The `resource` object representing a file hosted on TransactionLink's servers. The file may have been uploaded by yourself using the create resource request (for example, when uploading documents) or it may have been created by workflow

## Create a new resource

> Create a new resource

```json
{"openapi":"3.0.1","info":{"title":"TransactionLink API","version":"v3"},"servers":[{"url":"https://api.transactionlink.io","description":"Production"},{"url":"https://api.sandbox.transactionlink.io","description":"Sandbox"}],"security":[{"bearerAuthJWT":[]}],"components":{"securitySchemes":{"bearerAuthJWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CreateResourceResponse":{"title":"CreateResourceResponse","required":["resourceId","resourceName","resourcePath"],"type":"object","properties":{"resourceId":{"type":"string","description":"Unique identifier of the created resource"},"resourcePath":{"type":"string","description":"Path to access the created resource"},"resourceName":{"type":"string","description":"Name of the created resource"}}},"ErrorResponse":{"required":["errors","fingerprint"],"type":"object","properties":{"fingerprint":{"type":"string","description":"Unique identifier for this error instance"},"errors":{"type":"array","description":"List of error details","items":{"required":["code","message"],"properties":{"code":{"type":"string","description":"Error code representing the type of error"},"message":{"type":"string","description":"Error message providing more details about the error"}}}}}}}},"paths":{"/resources":{"post":{"tags":["Resources"],"summary":"Create a new resource","description":"Create a new resource","operationId":"create-resource","parameters":[{"name":"Authorization","in":"header","description":"Bearer token for authentication","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Content type of the request - multipart/form-data","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Upload file request","content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"201","headers":{"Content-Type":{"description":"Content type of the response - application/json","style":"simple","explode":false,"schema":{"type":"string"}}},"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CreateResourceResponse"}}}},"400":{"description":"Bad Request – invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized – JWT token missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden – insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found – resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error – unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Retrieve a specific resource

> Retrieve a specific resource

```json
{"openapi":"3.0.1","info":{"title":"TransactionLink API","version":"v3"},"servers":[{"url":"https://api.transactionlink.io","description":"Production"},{"url":"https://api.sandbox.transactionlink.io","description":"Sandbox"}],"security":[{"bearerAuthJWT":[]}],"components":{"securitySchemes":{"bearerAuthJWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"GetResourceResponse":{"title":"GetResourceResponse","type":"object"},"ErrorResponse":{"required":["errors","fingerprint"],"type":"object","properties":{"fingerprint":{"type":"string","description":"Unique identifier for this error instance"},"errors":{"type":"array","description":"List of error details","items":{"required":["code","message"],"properties":{"code":{"type":"string","description":"Error code representing the type of error"},"message":{"type":"string","description":"Error message providing more details about the error"}}}}}}}},"paths":{"/resources/{resourceId}":{"get":{"tags":["Resources"],"summary":"Retrieve a specific resource","description":"Retrieve a specific resource","operationId":"get-resource","parameters":[{"name":"resourceId","in":"path","description":"Unique identifier of the resource to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer token for authentication","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","headers":{"Content-Type":{"description":"Content type of the resource","style":"simple","explode":false,"schema":{"type":"string"}}},"content":{"application/pdf;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GetResourceResponse"}}}},"400":{"description":"Bad Request – invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized – JWT token missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden – insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found – resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error – unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.transactionlink.io/docs/v1/transactionlink-api/api-reference/resources.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.