gospace AIDocsAdmin Console

System API

Retrieve a list of supported countries

get

Returns a list of all supported countries with their ISO codes, currencies, calling codes, and timezones.

Authorizations
Responses
200
Successfully retrieved list of countries
application/json
get
GET /gospace/v1/country HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": [
    {
      "_id": "67581d8121c115b2ae8c940c",
      "name": "United Kingdom",
      "iso2": "GB",
      "iso3": "GBR",
      "currency": "GBP",
      "calling_code": 44,
      "timezones": [
        "Europe/London"
      ],
      "country_id": "67581d8121c115b2ae8c940c"
    },
    {
      "_id": "67581d8121c115b2ae8c940d",
      "name": "United States",
      "iso2": "US",
      "iso3": "USA",
      "currency": "USD",
      "calling_code": 1,
      "timezones": [
        "US/Pacific",
        "US/Mountain",
        "US/Central",
        "US/Eastern",
        "US/Hawaii",
        "US/Alaska"
      ],
      "country_id": "67581d8121c115b2ae8c940d"
    }
  ]
}

Retrieve list of uploads

get

Retrieves a list of upload records associated with the provided API key from the gospace platform. Each upload includes its status, file type, process type, and associated metadata. Supported file types and their extensions are image/png (.png), image/jpg (.jpg), image/jpeg (.jpeg), text/csv (.csv), text/dxf (.dxf), text/pdf (.pdf), application/json (.json), application/geo+json (.geojson), application/dxf (.dxf), application/acad (.dwg).

Authorizations
Responses
200
Successful response with a list of upload records
application/json
get
GET /gospace/v1/upload HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": [
    {
      "status": "PENDING",
      "file_type": "application/dxf",
      "upload_process": "floorplan",
      "binding_id": "dd42dd18-2e2b-47f2-9155-56ae649108ea",
      "signed_url": "https://gospace...",
      "created_at": "2025-07-24T11:49:18.995Z",
      "updated_at": "2025-07-24T11:49:18.995Z"
    }
  ],
  "identifier": "get_upload_file_successful"
}

Upload a file to gospace

post

Initiates a file upload process by generating a signed URL for uploading a file to the gospace platform. The file_type must be one of the supported MIME types, and the upload_process must match a valid process type. Supported file types and their extensions are image/png (.png), image/jpg (.jpg), image/jpeg (.jpeg), text/csv (.csv), text/dxf (.dxf), text/pdf (.pdf), application/json (.json), application/geo+json (.geojson), application/dxf (.dxf), application/acad (.dwg).

Authorizations
Body
file_typestring · enumRequired

The MIME type of the file to be uploaded.

Example: application/dxfPossible values:
upload_processstring · enumRequired

The type of upload process.

Example: floorplanPossible values:
binding_idstring · uuidRequired

A unique identifier for binding the upload to a specific entity.

Example: b51eadf5-e87b-49ec-a7bb-6e83152db660
Responses
200
Successful response with upload details and signed URL
application/json
post
POST /gospace/v1/upload HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "file_type": "application/dxf",
  "upload_process": "floorplan",
  "binding_id": "b51eadf5-e87b-49ec-a7bb-6e83152db660"
}
{
  "success": true,
  "data": {
    "upload_id": "68821e0fc57c69a6fd2f58e5",
    "file_uuid": "8cab4c54-b816-4d7d-82d4-5f329a0a3c03",
    "signed_url": "https://gospace-assets-uat-data.s3.eu-west-2.amazonaws.com/uploads/floorplan/uat_4e6f10f3f296/68f89cba-10a6-46ac-91a3-8ff521dee200/8cab4c54-b816-4d7d-82d4-5f329a0a3c03.dxf?X-Amz-Algorithm=AWS4-HMAC-SHA256&...",
    "file_name": "8cab4c54-b816-4d7d-82d4-5f329a0a3c03.dxf"
  },
  "identifier": "upload_file_successful"
}
PreviousCreate connections and label spaceNextAuthentication API

Last updated

Was this helpful?