---
updatedAt: 2026-09-02T17:35:26.000Z
agentTools:
  projectIndex: https://docs.go.v7labs.com/llms.txt
---

# Retrieve a url to upload a file to a field

Start the file upload process for a given entity property.
Use the retrieved `file_upload_url` to upload the file to the storage.
After file is uploaded use returned `confirm_upload_url` to confirm the upload.
Be sure to use provided confirm URL as this request may redirect you to different
Sub-Project as result of upload initiation.


**Note:** `project_id` is the same as `agent_id`

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Common.Filename": {
        "example": "example.png",
        "title": "Common.Filename",
        "type": "string",
        "x-struct": null,
        "x-validate": "Elixir.AgiDbWeb.Schemas.Common.FilenameValidator"
      },
      "Common.APIErrorDetails": {
        "description": "Additional structured error context. Shape varies by error code.\n\n- For conflict errors: contains a `conflicts` array with conflicting resources\n- For other errors: may contain arbitrary error-specific context",
        "nullable": true,
        "oneOf": [
          {
            "$ref": "#/components/schemas/Common.ConflictErrorDetails"
          },
          {
            "additionalProperties": true,
            "description": "Generic error details for non-conflict errors",
            "type": "object",
            "x-struct": null,
            "x-validate": null
          }
        ],
        "title": "Common.APIErrorDetails",
        "x-struct": "Elixir.AgiDbWeb.Schemas.Common.APIErrorDetails",
        "x-validate": null
      },
      "Projects.PropertyIdOrSlug": {
        "description": "Property ID or slug",
        "example": "property-name",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^[a-z_-][a-z0-9_-]*$",
        "title": "Projects.PropertyIdOrSlug",
        "type": "string",
        "x-struct": "Elixir.AgiDbWeb.Schemas.Projects.PropertyIdOrSlug",
        "x-validate": null
      },
      "Common.ConflictErrorDetails": {
        "additionalProperties": false,
        "description": "Details for conflict errors",
        "properties": {
          "conflicts": {
            "description": "List of conflicting resources",
            "items": {
              "additionalProperties": true,
              "type": "object",
              "x-struct": null,
              "x-validate": null
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          }
        },
        "required": [
          "conflicts"
        ],
        "title": "Common.ConflictErrorDetails",
        "type": "object",
        "x-struct": "Elixir.AgiDbWeb.Schemas.Common.ConflictErrorDetails",
        "x-validate": null
      },
      "Projects.StartFileUploadRequest": {
        "additionalProperties": false,
        "description": "Request for a URL for a file upload for a field",
        "properties": {
          "filename": {
            "$ref": "#/components/schemas/Common.Filename"
          }
        },
        "required": [
          "filename"
        ],
        "title": "Projects.StartFileUploadRequest",
        "type": "object",
        "x-struct": "Elixir.AgiDbWeb.Schemas.Projects.StartFileUploadRequest",
        "x-validate": null
      },
      "Common.UUID": {
        "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
        "format": "uuid",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
        "title": "Common.UUID",
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "Common.URL": {
        "example": "https://example.com",
        "pattern": "^http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\\(\\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+$",
        "title": "Common.URL",
        "type": "string",
        "x-struct": "Elixir.AgiDbWeb.Schemas.Common.URL",
        "x-validate": null
      },
      "Projects.StartFileUploadResponse": {
        "additionalProperties": false,
        "description": "URL to upload a file for a field.",
        "properties": {
          "confirm_upload_url": {
            "$ref": "#/components/schemas/Common.URL"
          },
          "file_upload_url": {
            "$ref": "#/components/schemas/Common.URL"
          }
        },
        "required": [
          "file_upload_url",
          "confirm_upload_url"
        ],
        "title": "Projects.StartFileUploadResponse",
        "type": "object",
        "x-struct": "Elixir.AgiDbWeb.Schemas.Projects.StartFileUploadResponse",
        "x-validate": null
      },
      "Common.APIError": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "example": "bad_request",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "details": {
            "$ref": "#/components/schemas/Common.APIErrorDetails"
          },
          "message": {
            "example": "Bad Request",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          }
        },
        "required": [
          "code",
          "message"
        ],
        "title": "Common.APIError",
        "type": "object",
        "x-struct": "Elixir.AgiDbWeb.Schemas.Common.APIError",
        "x-validate": null
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      },
      "BearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "V7 Go API",
    "version": "0.1.0"
  },
  "openapi": "3.0.0",
  "paths": {
    "/api/workspaces/{workspace_id}/projects/{project_id}/entities/{entity_id}/properties/{property_id_or_slug}/start_file_upload": {
      "post": {
        "callbacks": {},
        "description": "Start the file upload process for a given entity property.\nUse the retrieved `file_upload_url` to upload the file to the storage.\nAfter file is uploaded use returned `confirm_upload_url` to confirm the upload.\nBe sure to use provided confirm URL as this request may redirect you to different\nSub-Project as result of upload initiation.\n",
        "operationId": "entity-start-file-upload",
        "parameters": [
          {
            "description": "",
            "in": "path",
            "name": "workspace_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Common.UUID"
            }
          },
          {
            "description": "",
            "in": "path",
            "name": "project_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Common.UUID"
            }
          },
          {
            "description": "",
            "in": "path",
            "name": "entity_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Common.UUID"
            }
          },
          {
            "description": "Property ID or slug",
            "in": "path",
            "name": "property_id_or_slug",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Projects.PropertyIdOrSlug"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Projects.StartFileUploadRequest"
              }
            }
          },
          "description": "Projects.StartFileUploadRequest",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Projects.StartFileUploadResponse"
                }
              }
            },
            "description": "Projects.StartFileUploadResponse"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          }
        },
        "summary": "Retrieve a url to upload a file to a field",
        "tags": [
          "Entities"
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    },
    {
      "ApiKeyAuth": []
    }
  ],
  "servers": [
    {
      "description": "EU",
      "url": "https://go.v7labs.com",
      "variables": {}
    },
    {
      "description": "US",
      "url": "https://go.us.v7labs.com",
      "variables": {}
    },
    {
      "description": "UAE",
      "url": "https://go.uae.v7labs.com",
      "variables": {}
    }
  ]
}
```