2025-12-16 changelogs

Breaking changes

notes

These changes require special attention. If your app uses these API resources, and you don't adjust your usage of the resources according to the following instructions, then your app might break when you update to this API version.

Error Response Format Updates

We've made several improvements to error handling, security, and consistency across the API. Most applications will need to update error handling code to accommodate new error codes.

---

Detailed Changes

1. Request ID Removal

The extensions.requestId field is no longer included in responses.

Before:

{
  "data": { "user": { "id": "39167" } },
  "extensions": {
    "requestId": "464686940c862692"
  }
}

After:

{
  "data": { "user": { "id": "39167" } }
}

---

2. Enhanced Error Information

Error responses now include more detailed location information.

After:

{
  "errors": [{
    "message": "Missing document",
    "locations": [{ "line": 1, "column": 82 }],
    "path": ["document", "exportDocuments", 0],
    "extensions": { "code": "BAD_USER_INPUT" }
  }]
}

---

3. Error Code Changes

Change 1: Unauthorized Field Access

New error code: UNAUTHORIZED_FIELD_OR_TYPE is now returned for unauthorized field access (previously FORBIDDEN).

Change 2: Missing Client ID

New error code: MISSING_CLIENT_ID is now returned when the clientid header is missing (previously caught under generic UNAUTHENTICATED).

---

4. Partial Data Responses

Errors may now include partial data instead of null data.

Before:

{
  "errors": [{ "message": "Unauthorized field or type" }]
}

After:

{
  "data": {
    "search": {
      "cursor": null,
      "totalCount": 0,
      "documents": []
    }
  },
  "errors": [{ "message": "Unauthorized field or type" }]
}

---

5. Service Name Field Change

Extension field renamed for consistency.

Before:

{
  "extensions": {
    "serviceName": "document"
  }
}

After:

{
  "extensions": {
    "service": "document"
  }
}

---

6. Improved Security in Error Messages

Error messages no longer expose sensitive information.

Before:

{
  "message": "Failed to authenticate token: 5f872137-901b-4..."
}

After:

{
  "message": "Invalid credentials"
}

---

Error Code Quick Reference

Error Code	Meaning	Action Required
UNAUTHORIZED_FIELD_OR_TYPE	Querying field not available to your account	Update query or request access
MISSING_CLIENT_ID	clientid header not provided	Add clientid header to request
UNAUTHENTICATED	Invalid or expired token	Reauthenticate
BAD_USER_INPUT	Invalid input data	Check input parameters
GRAPHQL_VALIDATION_FAILED	Query syntax error	Fix GraphQL query

---

Need Help?

If you have questions about these changes:

• 📧 Email: apisupport@alpha-sense.com
• 📚 Check our FAQ
• 📖 Review API Documentation