aipoch/encode-api

ENCODE API Skill

This skill allows you to interact with the ENCODE Project database via its REST API.

When to Use

• Use this skill when the request matches its documented task boundary.
• Use it when the user can provide the required inputs and expects a structured deliverable.
• Prefer this skill for repeatable, checklist-driven execution rather than open-ended brainstorming.

Key Features

• Scope-focused workflow aligned to: Access the ENCODE Project REST API to search for and retrieve biological data (biosamples, experiments, etc.). Use this skill when the user needs to query ENCODE data, search by keywords, or retrieve specific objects by accession ID.
• Packaged executable path(s): scripts/encode_client.py.
• Structured execution path designed to keep outputs consistent and reviewable.

Dependencies

• requests (Install via pip install -r requirements.txt)

Example Usage

See ## Usage above for related details.

cd "20260316/scientific-skills/Evidence Insight/encode-api"
python -m py_compile scripts/encode_client.py
python scripts/encode_client.py --help

Example run plan:

1. Confirm the user input, output path, and any required config values.
2. Edit the in-file CONFIG block or documented parameters if the script uses fixed settings.
3. Run python scripts/encode_client.py with the validated inputs.
4. Review the generated output and return the final artifact with any assumptions called out.

Implementation Details

• Execution model: validate the request, choose the packaged workflow, and produce a bounded deliverable.
• Input controls: confirm the source files, scope limits, output format, and acceptance criteria before running any script.
• Primary implementation surface: scripts/encode_client.py.
• Parameters to clarify first: input path, output path, scope filters, thresholds, and any domain-specific constraints.
• Output discipline: keep results reproducible, identify assumptions explicitly, and avoid undocumented side effects.

Usage

You can use the provided Python script scripts/encode_client.py to perform searches or retrieve specific objects.

1. Search for Objects

To search for data using keywords:

from scripts.encode_client import search_encode

results = search_encode(term="bone chip", limit=10)
print(results)

2. Get Object by Accession

To retrieve a specific object (e.g., a Biosample or Experiment) by its accession ID:

from scripts.encode_client import get_object

data = get_object(accession="ENCBS000AAA")
print(data)

API Reference

• Base URL: https://www.encodeproject.org/
• Rate Limit: 10 requests/second
• Authentication: Public data is accessible without keys. For private data, provide api_key and api_secret to the functions.

When Not to Use

• Do not use this skill when the required source data, identifiers, files, or credentials are missing.
• Do not use this skill when the user asks for fabricated results, unsupported claims, or out-of-scope conclusions.
• Do not use this skill when a simpler direct answer is more appropriate than the documented workflow.

Required Inputs

• A clearly specified task goal aligned with the documented scope.
• All required files, identifiers, parameters, or environment variables before execution.
• Any domain constraints, formatting requirements, and expected output destination if applicable.

Recommended Workflow

1. Validate the request against the skill boundary and confirm all required inputs are present.
2. Select the documented execution path and prefer the simplest supported command or procedure.
3. Produce the expected output using the documented file format, schema, or narrative structure.
4. Run a final validation pass for completeness, consistency, and safety before returning the result.

Output Contract

• Return a structured deliverable that is directly usable without reformatting.
• If a file is produced, prefer a deterministic output name such as encode_api_result.md unless the skill documentation defines a better convention.
• Include a short validation summary describing what was checked, what assumptions were made, and any remaining limitations.

Validation and Safety Rules

• Validate required inputs before execution and stop early when mandatory fields or files are missing.
• Do not fabricate measurements, references, findings, or conclusions that are not supported by the provided source material.
• Emit a clear warning when credentials, privacy constraints, safety boundaries, or unsupported requests affect the result.
• Keep the output safe, reproducible, and within the documented scope at all times.

Failure Handling

• If validation fails, explain the exact missing field, file, or parameter and show the minimum fix required.
• If an external dependency or script fails, surface the command path, likely cause, and the next recovery step.
• If partial output is returned, label it clearly and identify which checks could not be completed.

Quick Validation

Run this minimal verification path before full execution when possible:

python scripts/encode_client.py --help

Expected output format:

Result file: encode_api_result.md
Validation summary: PASS/FAIL with brief notes
Assumptions: explicit list if any