Clarity Fold Status Skill
Get overview and status information about Clarity Protocol's protein folding research database, including API capabilities, available endpoints, and data statistics.
Quick Start
Get full status report:
CODEBLOCK0
Get status in JSON format:
CODEBLOCK1
Status Information
The status check provides:
- - API version: Current API version
- API description: What the API provides
- Total variants: Count of protein variants in database
- Available endpoints: List of all API endpoints
- Rate limits: Anonymous and authenticated limits
- Data freshness: When data was last updated
API Endpoints
The Clarity Protocol API v1 provides these endpoints:
- -
GET /api/v1/: API information - INLINECODE1 : List all variants (with filters)
- INLINECODE2 : Get variant details
- INLINECODE3 : Get agent findings
- INLINECODE4 : List research papers
- INLINECODE5 : Get paper details
- INLINECODE6 : List clinical variants
- INLINECODE7 : Get clinical variant details
Rate Limits
- - Anonymous (no API key): 10 requests/minute
- With API key: 100 requests/minute
To use an API key, set the CLARITY_API_KEY environment variable:
CODEBLOCK2
Get your API key at https://clarityprotocol.io
Error Handling
429 Rate Limit: You've exceeded the rate limit. The script will display how long to wait.
500 Server Error: The API server encountered an error. Try again later.
Timeout: The request took longer than 30 seconds.
Use Cases
- - Check if the API is available
- Get an overview of available data
- Verify endpoint URLs before making requests
- Monitor rate limit status
- Understand API capabilities for integration planning
Clarity折叠状态技能
获取Clarity协议蛋白质折叠研究数据库的概览和状态信息,包括API功能、可用端点和数据统计。
快速开始
获取完整状态报告:
bash
python scripts/check_status.py
以JSON格式获取状态:
bash
python scripts/check_status.py --format json
状态信息
状态检查提供以下内容:
- - API版本:当前API版本
- API描述:API提供的功能
- 总变体数:数据库中的蛋白质变体数量
- 可用端点:所有API端点列表
- 速率限制:匿名和认证限制
- 数据新鲜度:数据最后更新时间
API端点
Clarity协议API v1提供以下端点:
- - GET /api/v1/:API信息
- GET /api/v1/variants:列出所有变体(支持筛选)
- GET /api/v1/variants/{foldid}:获取变体详情
- GET /api/v1/variants/{foldid}/findings:获取智能体发现结果
- GET /api/v1/literature:列出研究论文
- GET /api/v1/literature/{pmid}:获取论文详情
- GET /api/v1/clinical:列出临床变体
- GET /api/v1/clinical/{gene}/{variant}:获取临床变体详情
速率限制
- - 匿名(无API密钥):10次请求/分钟
- 使用API密钥:100次请求/分钟
要使用API密钥,请设置CLARITYAPIKEY环境变量:
bash
export CLARITYAPIKEY=yourkeyhere
python scripts/check_status.py
在https://clarityprotocol.io获取您的API密钥
错误处理
429速率限制:您已超出速率限制。脚本将显示需要等待的时间。
500服务器错误:API服务器遇到错误。请稍后重试。
超时:请求耗时超过30秒。
使用场景
- - 检查API是否可用
- 获取可用数据概览
- 在发起请求前验证端点URL
- 监控速率限制状态
- 了解API功能以进行集成规划